Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: uri ::

interface XUriReference
Description
represents generic, mutable URI references.

See RFC 2396 for a description of URI references and related terms.

This interface only handles generic URI references (both absolute and relative). For specific URI schemes, there will be additional interfaces that offer extra, scheme-specific functionality.

Since
OOo 2.0
See also
UriReferenceFactory
which allows to create URI reference objects that support XUriReference and additional, scheme-specific interfaces.

Methods' Summary
getUriReference returns the textual representation of the complete URI reference.  
isAbsolute returns whether this URI reference is absolute or relative.  
getScheme returns the scheme part of this (absolute) URI reference.  
getSchemeSpecificPart returns the scheme-specific part of this URI reference.  
isHierarchical returns whether this URI reference is hierarchical or opaque.  
hasAuthority returns whether this (hierarchical) URI reference has an authority part.  
getAuthority returns the authority part of this (hierarchical) URI reference.  
getPath returns the path part of this URI reference.  
hasRelativePath returns whether this (relative) URI reference has a relative path.  
getPathSegmentCount returns the number of path segments of this (hierarchical) URI reference.  
getPathSegment returns a given path segment of this (hierarchical) URI reference.  
hasQuery returns whether this (hierarchical) URI reference has a query part.  
getQuery returns the query part of this (hierarchical) URI reference.  
hasFragment returns whether this URI reference has a fragment part.  
getFragment returns the fragment part of this URI reference.  
setFragment sets the fragment part of this URI reference.  
clearFragment clears the fragment part of this URI reference.  
Methods' Details
getUriReference
string
getUriReference();

Description
returns the textual representation of the complete URI reference.
Returns
the textual representation of the complete URI reference. The exact spelling of the URI reference is retained.
isAbsolute
boolean
isAbsolute();

Description
returns whether this URI reference is absolute or relative.
Returns
true if this URI reference is absolute, false if it is relative.
getScheme
string
getScheme();

Description
returns the scheme part of this (absolute) URI reference.
Returns
the textual representation of the scheme part (with the exact spelling retained; without the delimiting “:”), if this is an absolute URI reference; otherwise, an empty string is returned.
getSchemeSpecificPart
string
getSchemeSpecificPart();

Description
returns the scheme-specific part of this URI reference.

For an absolute URI reference, the scheme-specific part is everything after the scheme part and the delimiting “:”, and before the optional “#” and fragment part. For a relative URI reference, the scheme-specific part is everything before the optional “#” and fragment part.

Returns
the textual representation of the scheme-specific part (with the exact spelling retained).
isHierarchical
boolean
isHierarchical();

Description
returns whether this URI reference is hierarchical or opaque.

An absolute URI reference is hierarchical if its scheme-specific part starts with “/”. A relative URI reference is always hierarchical.

Returns
true if this URI reference is hierarchical, false if it is opaque.
hasAuthority
boolean
hasAuthority();

Description
returns whether this (hierarchical) URI reference has an authority part.
Returns
true if this URI reference is hierarchical and has an authority part.
getAuthority
string
getAuthority();

Description
returns the authority part of this (hierarchical) URI reference.
Returns
the textual representation of the authority part (with the exact spelling retained), if this is a hierarchical URI reference that has an authority part; otherwise, an empty string is returned.
getPath
string
getPath();

Description
returns the path part of this URI reference.
Returns
the textual representation of the path part (with the exact spelling retained), if this is a hierarchical URI reference; for an opaque URI reference, the scheme-specific part (with the exact spelling retained) is returned.
hasRelativePath
boolean
hasRelativePath();

Description
returns whether this (relative) URI reference has a relative path.
Returns
true if this URI reference is relative and has a relative path.
getPathSegmentCount
long
getPathSegmentCount();

Description
returns the number of path segments of this (hierarchical) URI reference.

For an opaque URI reference, and for a hierarchical URI reference with an empty path, the number of path segments is zero. For a hierarchical URI reference with an absolute, non-empty path, the number of path segments equals the number of “/” delimiters. For a hierarchical URI reference with a relative, non-empty path, the number of path segments equals the number of “/” delimiters, plus one.

Returns
the number of path segments.
getPathSegment
string
getPathSegment( [in] long  index );

Description
returns a given path segment of this (hierarchical) URI reference.
Parameter index
the index of the path segment, starting at zero.
Returns
the textual representation of the given path segment (with the exact spelling retained, without any delimiting “/”), if this URI reference is hierarchical and has that many path segments; otherwise, and in particular if index is negative, an empty string is returned.
hasQuery
boolean
hasQuery();

Description
returns whether this (hierarchical) URI reference has a query part.
Returns
true if this URI reference is hierarchical and has a query part.
getQuery
string
getQuery();

Description
returns the query part of this (hierarchical) URI reference.
Returns
the textual representation of the query part (with the exact spelling retained; without the delimiting “?”), if this is a hierarchical URI reference that has a query part; otherwise, an empty string is returned.
hasFragment
boolean
hasFragment();

Description
returns whether this URI reference has a fragment part.
Returns
true if this URI reference has a fragment part.
getFragment
string
getFragment();

Description
returns the fragment part of this URI reference.
Returns
the textual representation of the fragment part (with the exact spelling retained; without the delimiting “#”), if this is a URI reference that has a fragment part; otherwise, an empty string is returned.
setFragment
void
setFragment( [in] string  fragment );

Description
sets the fragment part of this URI reference.
Parameter fragment
the textual representation of the new fragment part. The exact spelling will be preserved, and no escaping is performed.
clearFragment
void
clearFragment();

Description
clears the fragment part of this URI reference.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.