<html> <head> <title>Interface XUriReference</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XUriReference-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">uri</a> :: </p> </td> </tr> <tr> <td class="title">interface XUriReference</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents generic, mutable URI references. </dd> <dd><p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a> for a description of URI references and related terms.</p> <p>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.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> <dt><b>See also</b></dt> <dd><a href="UriReferenceFactory.html">UriReferenceFactory</a><br> which allows to create URI reference objects that support <a href="XUriReference.html">XUriReference</a> and additional, scheme-specific interfaces. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getUriReference">getUriReference</a></td> <td class="imsum_right">returns the textual representation of the complete URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#isAbsolute">isAbsolute</a></td> <td class="imsum_right">returns whether this URI reference is absolute or relative. </td> </tr> <tr> <td class="imsum_left"><a href="#getScheme">getScheme</a></td> <td class="imsum_right">returns the scheme part of this (absolute) URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#getSchemeSpecificPart">getSchemeSpecificPart</a></td> <td class="imsum_right">returns the scheme-specific part of this URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#isHierarchical">isHierarchical</a></td> <td class="imsum_right">returns whether this URI reference is hierarchical or opaque. </td> </tr> <tr> <td class="imsum_left"><a href="#hasAuthority">hasAuthority</a></td> <td class="imsum_right">returns whether this (hierarchical) URI reference has an authority part. </td> </tr> <tr> <td class="imsum_left"><a href="#getAuthority">getAuthority</a></td> <td class="imsum_right">returns the authority part of this (hierarchical) URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#getPath">getPath</a></td> <td class="imsum_right">returns the path part of this URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#hasRelativePath">hasRelativePath</a></td> <td class="imsum_right">returns whether this (relative) URI reference has a relative path. </td> </tr> <tr> <td class="imsum_left"><a href="#getPathSegmentCount">getPathSegmentCount</a></td> <td class="imsum_right">returns the number of path segments of this (hierarchical) URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#getPathSegment">getPathSegment</a></td> <td class="imsum_right">returns a given path segment of this (hierarchical) URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#hasQuery">hasQuery</a></td> <td class="imsum_right">returns whether this (hierarchical) URI reference has a query part. </td> </tr> <tr> <td class="imsum_left"><a href="#getQuery">getQuery</a></td> <td class="imsum_right">returns the query part of this (hierarchical) URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#hasFragment">hasFragment</a></td> <td class="imsum_right">returns whether this URI reference has a fragment part. </td> </tr> <tr> <td class="imsum_left"><a href="#getFragment">getFragment</a></td> <td class="imsum_right">returns the fragment part of this URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#setFragment">setFragment</a></td> <td class="imsum_right">sets the fragment part of this URI reference. </td> </tr> <tr> <td class="imsum_left"><a href="#clearFragment">clearFragment</a></td> <td class="imsum_right">clears the fragment part of this URI reference. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getUriReference" class="membertitle">getUriReference</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getUriReference</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the textual representation of the complete URI reference. </dd> <dt><b>Returns</b></dt> <dd>the textual representation of the complete URI reference. The exact spelling of the URI reference is retained. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isAbsolute" class="membertitle">isAbsolute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isAbsolute</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this URI reference is absolute or relative. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URI reference is absolute, <b>false</b> if it is relative. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getScheme" class="membertitle">getScheme</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getScheme</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the scheme part of this (absolute) URI reference. </dd> <dt><b>Returns</b></dt> <dd>the textual representation of the scheme part (with the exact spelling retained; without the delimiting “<code>:</code>”), if this is an absolute URI reference; otherwise, an empty <code>string</code> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSchemeSpecificPart" class="membertitle">getSchemeSpecificPart</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getSchemeSpecificPart</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the scheme-specific part of this URI reference. </dd> <dd><p>For an absolute URI reference, the scheme-specific part is everything after the scheme part and the delimiting “<code>:</code>”, and before the optional “<code>#</code>” and fragment part. For a relative URI reference, the scheme-specific part is everything before the optional “<code>#</code>” and fragment part.</p> </dd> <dt><b>Returns</b></dt> <dd>the textual representation of the scheme-specific part (with the exact spelling retained). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isHierarchical" class="membertitle">isHierarchical</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isHierarchical</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this URI reference is hierarchical or opaque. </dd> <dd><p>An absolute URI reference is hierarchical if its scheme-specific part starts with “<code>/</code>”. A relative URI reference is always hierarchical.</p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URI reference is hierarchical, <b>false</b> if it is opaque. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasAuthority" class="membertitle">hasAuthority</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasAuthority</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this (hierarchical) URI reference has an authority part. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URI reference is hierarchical and has an authority part. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAuthority" class="membertitle">getAuthority</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getAuthority</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the authority part of this (hierarchical) URI reference. </dd> <dt><b>Returns</b></dt> <dd>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 <code>string</code> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPath" class="membertitle">getPath</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getPath</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the path part of this URI reference. </dd> <dt><b>Returns</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasRelativePath" class="membertitle">hasRelativePath</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasRelativePath</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this (relative) URI reference has a relative path. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URI reference is relative and has a relative path. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPathSegmentCount" class="membertitle">getPathSegmentCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getPathSegmentCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the number of path segments of this (hierarchical) URI reference. </dd> <dd><p>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 “<code>/</code>” delimiters. For a hierarchical URI reference with a relative, non-empty path, the number of path segments equals the number of “<code>/</code>” delimiters, plus one.</p> </dd> <dt><b>Returns</b></dt> <dd>the number of path segments. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPathSegment" class="membertitle">getPathSegment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getPathSegment</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> index );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a given path segment of this (hierarchical) URI reference. </dd> <dt><b>Parameter index</b></dt> <dd>the index of the path segment, starting at zero. </dd> <dt><b>Returns</b></dt> <dd>the textual representation of the given path segment (with the exact spelling retained, without any delimiting “<code>/</code>”), if this URI reference is hierarchical and has that many path segments; otherwise, and in particular if <code>index</code> is negative, an empty <code>string</code> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasQuery" class="membertitle">hasQuery</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasQuery</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this (hierarchical) URI reference has a query part. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URI reference is hierarchical and has a query part. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getQuery" class="membertitle">getQuery</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getQuery</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the query part of this (hierarchical) URI reference. </dd> <dt><b>Returns</b></dt> <dd>the textual representation of the query part (with the exact spelling retained; without the delimiting “<code>?</code>”), if this is a hierarchical URI reference that has a query part; otherwise, an empty <code>string</code> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasFragment" class="membertitle">hasFragment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasFragment</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this URI reference has a fragment part. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URI reference has a fragment part. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFragment" class="membertitle">getFragment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getFragment</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the fragment part of this URI reference. </dd> <dt><b>Returns</b></dt> <dd>the textual representation of the fragment part (with the exact spelling retained; without the delimiting “<code>#</code>”), if this is a URI reference that has a fragment part; otherwise, an empty <code>string</code> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setFragment" class="membertitle">setFragment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setFragment</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> fragment );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the fragment part of this URI reference. </dd> <dt><b>Parameter fragment</b></dt> <dd>the textual representation of the new fragment part. The exact spelling will be preserved, and no escaping is performed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearFragment" class="membertitle">clearFragment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>clearFragment</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>clears the fragment part of this URI reference. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
