interface XContentIdentifierMapping in module com::sun::star::ucb::

(Global Index)

Syntax

interface XContentIdentifierMapping : com::sun::star::uno::XInterface ;

Description

A mapping from a (source) set of XContentIdentifier s to another (target) set of XContentIdentifiers.

For convenience and performance, mapping between the string representations of source/target XContentIdentifiers, as well as mapping between XContent s 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

See also

XContentAccess

See also

XContentIdentifier

Method 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 XRow .

Method Details



mapContentIdentifierString

Syntax

string mapContentIdentifierString (
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

Syntax

com::sun::star::ucb::XContentIdentifier mapContentIdentifier (
com::sun::star::ucb::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

Syntax

com::sun::star::ucb::XContent mapContent (
com::sun::star::ucb::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

Syntax

boolean mapRow (
sequence< any > Value );

Description

Map the content identifiers (or related data) contained in the columns of a 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