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 :: ucb ::

interface XContentIdentifierMapping
Description
A mapping from a (source) set of XContentIdentifiers to another (target) set of XContentIdentifiers.

For convenience and performance, mapping between the string representations of source/target XContentIdentifiers, as well as mapping between XContents identified by source/target XContentIdentifiers is also supported.

This interface can be useful in cases where the identifieres (and associated contents) returned by the various methods of an XContentAccess need to be mapped to some other space of identifiers (and associated contents).

See also
XContent, XContentAccess, XContentIdentifier

Methods' Summary
mapContentIdentifierString Map the string representation of an XContentIdentifier.  
mapContentIdentifier Map an XContentIdentifier.  
mapContent Map the XContent identified by an XContentIdentifier.  
mapRow Map the content identifiers (or related data) contained in the columns of a ::com::sun::star::sdbc::XRow.  
Methods' Details
mapContentIdentifierString
string
mapContentIdentifierString( [in] string  Source );

Description
Map the string representation of an XContentIdentifier.
Parameter Source
The string representation of an XContentIdentifier from the source set.
Returns
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.
mapContentIdentifier
XContentIdentifier
mapContentIdentifier( [in] XContentIdentifier  Source );

Description
Map an XContentIdentifier.
Parameter Source
An XContentIdentifier from the source set.
Returns
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.
mapContent
XContent
mapContent( [in] XContent  Source );

Description
Map the XContent identified by an XContentIdentifier.
Parameter Source
The XContent identified by an XContentIdentifier from the source set.
Returns
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.
mapRow
boolean
mapRow( [inout] sequence< any >  Value );

Description
Map the content identifiers (or related data) contained in the columns of a ::com::sun::star::sdbc::XRow.
Parameter Value
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).
Returns
true 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.
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.