Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 7857

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XUriReferenceFactory</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="XUriReferenceFactory-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 XUriReferenceFactory</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>creates URI references.

 </dd>
<dd><p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a> for a
 description of URI references and related terms.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</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="#parse">parse</a></td>
<td class="imsum_right">parses the textual representation of a URI reference.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#makeAbsolute">makeAbsolute</a></td>
<td class="imsum_right">resolves a relative URI reference to absolute form.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#makeRelative">makeRelative</a></td>
<td class="imsum_right">changes an absolute URI refrence to relative form.

 &nbsp;</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="parse" class="membertitle">parse</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"><a href="XUriReference.html">XUriReference</a></td>
</tr>
<tr>
<td valign="top"><b>parse</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;uriReference );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>parses the textual representation of a URI reference.

 </dd>
<dt><b>Parameter uriReference</b></dt>
<dd>the textual representation of a URI reference.

 </dd>
<dt><b>Returns</b></dt>
<dd>an object that supports
 <a href="XUriReference.html">XUriReference</a> (and possibly also
 additional, scheme-specific interfaces), if the given input can be parsed
 into a URI reference; otherwise, <b>NULL</b> is returned.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="makeAbsolute" class="membertitle">makeAbsolute</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"><a href="XUriReference.html">XUriReference</a></td>
</tr>
<tr>
<td valign="top"><b>makeAbsolute</b>(</td>
<td valign="top">[in] <a href="XUriReference.html">XUriReference</a></td>
<td valign="bottom">&nbsp;baseUriReference,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XUriReference.html">XUriReference</a></td>
<td valign="bottom">&nbsp;uriReference,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;processSpecialBaseSegments,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="RelativeUriExcessParentSegments.html">RelativeUriExcessParentSegments</a></td>
<td valign="bottom">&nbsp;excessParentSegments );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>resolves a relative URI reference to absolute form.

 </dd>
<dt><b>Parameter baseUriReference</b></dt>
<dd>the base URI reference. If the given <code>uriReference</code> is a
 same-document reference, <code>baseUriReference</code> is used as a
 reference to the current document.

 </dd>
<dt><b>Parameter uriReference</b></dt>
<dd>any URI reference. Backwards-compatible relative URI references starting
 with a scheme component (see RFC&nbsp;2396, Section&nbsp;5.2,
 step&nbsp;3) are not supported; instead, they are interpreted as absolute
 URI references.

 </dd>
<dt><b>Parameter processSpecialBaseSegments</b></dt>
<dd>if <b>true</b>, special segments (&ldquo;<code>.</code>&rdquo; and
 &ldquo;<code>..</code>&rdquo;) within the path of the base URI (except
 for the last, cut-off segment) are processed as suggested by
 RFC&nbsp;2396. If <b>false</b>, special segments within the path of the base
 URI are treated like ordinary segments.

 </dd>
<dt><b>Parameter excessParentSegments</b></dt>
<dd>details how excess special parent segments
 (&ldquo;<code>..</code>&rdquo;) are handled.

 </dd>
<dt><b>Returns</b></dt>
<dd>a fresh object that supports
 <a href="XUriReference.html">XUriReference</a> (and possibly also
 additional, scheme-specific interfaces), if the given
 <code>uriReference</code> is either already absolute, or can be resolved
 to an absolute URI reference, relative to the given
 <code>baseUriReference</code>; otherwise, <b>NULL</b> is returned.
 Especially, if <code>baseUriReference</code> is <b>NULL</b>, or is not an
 absolute, hierarchical URI reference, or if <code>uriReference</code> is
 <b>NULL</b>, then <b>NULL</b> is always returned.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="makeRelative" class="membertitle">makeRelative</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"><a href="XUriReference.html">XUriReference</a></td>
</tr>
<tr>
<td valign="top"><b>makeRelative</b>(</td>
<td valign="top">[in] <a href="XUriReference.html">XUriReference</a></td>
<td valign="bottom">&nbsp;baseUriReference,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XUriReference.html">XUriReference</a></td>
<td valign="bottom">&nbsp;uriReference,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;preferAuthorityOverRelativePath,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;preferAbsoluteOverRelativePath,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;encodeRetainedSpecialSegments );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>changes an absolute URI refrence to relative form.

 </dd>
<dt><b>Parameter baseUriReference</b></dt>
<dd>the base URI reference.

 </dd>
<dt><b>Parameter uriReference</b></dt>
<dd>any URI reference.

 </dd>
<dt><b>Parameter preferAuthorityOverRelativePath</b></dt>
<dd>controls how a relative URI reference is generated when both
 <code>baseUriReference</code> (e.g.,
 &ldquo;<code>scheme://auth/a/b</code>&rdquo;) and
 <code>uriReference</code> (e.g.,
 &ldquo;<code>scheme://auth//c/d</code>&rdquo;) have the same scheme and
 authority components, and the path component of <code>uriReference</code>
 starts with &ldquo;<code>//</code>&rdquo;. If <b>true</b>, the generated
 relative URI reference includes an authority component (e.g.,
 &ldquo;<code>//auth//c/d</code>&rdquo;); if <b>false</b>, the generated
 relative URI reference has a relative path (e.g.,
 &ldquo;<code>..//c/d</code>&rdquo;).

 </dd>
<dt><b>Parameter preferAbsoluteOverRelativePath</b></dt>
<dd>controls how a relative URI reference is generated when both
 <code>baseUriReference</code> (e.g.,
 &ldquo;<code>scheme://auth/a/b</code>&rdquo;) and
 <code>uriReference</code> (e.g.,
 &ldquo;<code>scheme://auth/c/d</code>&rdquo;) have the same scheme and
 authority components (if present), but share no common path segments. If
 <b>true</b>, the generated relative URI reference has an absolute path (e.g.,
 &ldquo;<code>/c/d</code>&rdquo;); if <b>false</b>, the generated relative URI
 reference has a relative path (e.g., &ldquo;<code>../c/d</code>&rdquo;).

 </dd>
<dt><b>Parameter encodeRetainedSpecialSegments</b></dt>
<dd>if <b>true</b>, special segments (&ldquo;<code>.</code>&rdquo; and
 &ldquo;<code>..</code>&rdquo;) that are already present in the path
 component of the given <code>uriReference</code> and which end up in a
 relative path returned from this method, are encoded (as
 &ldquo;<code>%2E</code>&rdquo; and &ldquo;<code>%2E%2E</code>&rdquo;,
 respectively).

 </dd>
<dt><b>Returns</b></dt>
<dd>a fresh object that supports
 <a href="XUriReference.html">XUriReference</a>, if the given
 <code>uriReference</code> is either already relative, or is not
 hierarchical, or is of a different scheme than the given
 <code>baseUriReference</code>, or can be changed to a relative URI
 reference, relative to the given <code>baseUriReference</code>;
 otherwise, <b>NULL</b> is returned. Especially, if
 <code>baseUriReference</code> is <b>NULL</b>, or is not an absolute,
 hierarchical URI reference, or if <code>uriReference</code> is <b>NULL</b>,
 then <b>NULL</b> is always returned.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>