Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 7250

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XContentIdentifierMapping</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="XContentIdentifierMapping-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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">ucb</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XContentIdentifierMapping</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>A mapping from a (source) set of <a href="XContentIdentifier.html">XContentIdentifier</a>s to
 another (target) set of XContentIdentifiers.

 </dd>
<dd><p>For convenience and performance, mapping between the string
 representations of source/target XContentIdentifiers, as well as mapping
 between <a href="XContent.html">XContent</a>s identified by source/target
 XContentIdentifiers is also supported.

 <p>This interface can be useful in cases where the identifieres (and
 associated contents) returned by the various methods of an
 <a href="XContentAccess.html">XContentAccess</a> need to be mapped to some other space of
 identifiers (and associated contents).

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XContent.html">XContent</a>, <a href="XContentAccess.html">XContentAccess</a>, <a href="XContentIdentifier.html">XContentIdentifier</a></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="#mapContentIdentifierString">mapContentIdentifierString</a></td>
<td class="imsum_right">Map the string representation of an <a href="XContentIdentifier.html">XContentIdentifier</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#mapContentIdentifier">mapContentIdentifier</a></td>
<td class="imsum_right">Map an <a href="XContentIdentifier.html">XContentIdentifier</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#mapContent">mapContent</a></td>
<td class="imsum_right">Map the <a href="XContent.html">XContent</a> identified by an
 <a href="XContentIdentifier.html">XContentIdentifier</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#mapRow">mapRow</a></td>
<td class="imsum_right">Map the content identifiers (or related data) contained in the columns
 of a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XRow.html">XRow</a>.

 &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="mapContentIdentifierString" class="membertitle">mapContentIdentifierString</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>mapContentIdentifierString</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Source );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Map the string representation of an <a href="XContentIdentifier.html">XContentIdentifier</a>.

 </dd>
<dt><b>Parameter Source</b></dt>
<dd>The string representation of an XContentIdentifier
 from the source set.

 </dd>
<dt><b>Returns</b></dt>
<dd>The string representation of the target set's
 XContentIdentifier corresponding to the source identifier. The
 returned string may be empty if either Source was empty already, or if
 there's no applicable target to map to.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="mapContentIdentifier" class="membertitle">mapContentIdentifier</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="XContentIdentifier.html">XContentIdentifier</a></td>
</tr>
<tr>
<td valign="top"><b>mapContentIdentifier</b>(</td>
<td valign="top">[in] <a href="XContentIdentifier.html">XContentIdentifier</a></td>
<td valign="bottom">&nbsp;Source );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Map an <a href="XContentIdentifier.html">XContentIdentifier</a>.

 </dd>
<dt><b>Parameter Source</b></dt>
<dd>An XContentIdentifier from the source set.

 </dd>
<dt><b>Returns</b></dt>
<dd>The target set's XContentIdentifier corresponding to the
 source identifier. The returned XContentIdentifier may be null if
 either Source was null already, or if there's no applicable target to
 map to.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="mapContent" class="membertitle">mapContent</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="XContent.html">XContent</a></td>
</tr>
<tr>
<td valign="top"><b>mapContent</b>(</td>
<td valign="top">[in] <a href="XContent.html">XContent</a></td>
<td valign="bottom">&nbsp;Source );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Map the <a href="XContent.html">XContent</a> identified by an
 <a href="XContentIdentifier.html">XContentIdentifier</a>.

 </dd>
<dt><b>Parameter Source</b></dt>
<dd>The XContent identified by an XContentIdentifier from
 the source set.

 </dd>
<dt><b>Returns</b></dt>
<dd>The XContent identified by the target set's
 XContentIdentifier corresponding to the source identifier. The
 returned XContent may be null if either Source was null already, or if
 there's no applicable target to map to.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="mapRow" class="membertitle">mapRow</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>mapRow</b>(</td>
<td valign="top">[inout] sequence&lt; any &gt;</td>
<td valign="bottom">&nbsp;Value );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Map the content identifiers (or related data) contained in the columns
 of a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XRow.html">XRow</a>.

 </dd>
<dt><b>Parameter Value</b></dt>
<dd>On input, a sequence of anys corresponding to the columns
 of the XRow (the first column goes into the zeroth position of the
 sequence, and so on). On output, the same sequence, but with the
 entries mapped as necessary. This is an inout parameter rather than a
 comination of in parameter and return value for performance reasons
 (assuming that in most cases most elements in the input sequence will
 be returned unmodified).

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if any of the columns contain data that (potentially)
 needs mapping (though maybe no mapping occured for the concrete input
 data of this call). This information can be useful to decide whether,
 for another row, a call to this function is at all necessary.
 </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; 2008 Sun Microsystems, Inc.</p>

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

</html>