org.apache.jackrabbit.spi

Interface IdFactory

All Known Implementing Classes:

AbstractIdFactory, IdFactoryImpl, IdFactoryLogger

public interface IdFactory

IdFactory defines methods to construct new ItemIds. This factory is intended to build ItemIds from the parameters passed to the various create methods and should not make an attempt to apply additional logic such as e.g. roundtrips to the server or resolution of Paths. Similarly the SPI implementation namely the RepositoryService must be able to deal with the various formats of an ItemId, since a caller may not (yet) be aware of the uniqueID part of an ItemId.

Method Summary

Modifier and Type	Method and Description
NodeId	createNodeId(NodeId parentId, Path path) Creates a new NodeId from the given parent id and the given Path object.
NodeId	createNodeId(String uniqueID) Creates a new NodeId from the given unique id.
NodeId	createNodeId(String uniqueID, Path path) Creates a new NodeId from the given unique id (which identifies an ancestor Node) and the given Path object.
PropertyId	createPropertyId(NodeId parentId, Name propertyName) Creates a new PropertyId from the given parent id and property name.
NodeId	fromJcrIdentifier(String jcrIdentifier) Create a new NodeId from the given JCR string representation.
String	toJcrIdentifier(NodeId nodeId) Returns the JCR string representation of the given nodeId.

Method Detail

createPropertyId

PropertyId createPropertyId(NodeId parentId,
                            Name propertyName)

Creates a new PropertyId from the given parent id and property name.

Parameters:

parentId -

propertyName -

Returns:

a new PropertyId.

createNodeId

NodeId createNodeId(NodeId parentId,
                    Path path)

Creates a new NodeId from the given parent id and the given Path object.

Parameters:

parentId -

path -

Returns:

a new NodeId.

createNodeId

NodeId createNodeId(String uniqueID,
                    Path path)

Creates a new NodeId from the given unique id (which identifies an ancestor Node) and the given Path object.

Parameters:

uniqueID -

path -

Returns:

a new NodeId.

See Also:

ItemId for a description of the uniqueID defined by the SPI item identifiers.

createNodeId

NodeId createNodeId(String uniqueID)

Creates a new NodeId from the given unique id.

Parameters:

uniqueID -

Returns:

a new NodeId.

See Also:

ItemId for a description of the uniqueID defined by the SPI item identifiers.

toJcrIdentifier

String toJcrIdentifier(NodeId nodeId)

Returns the JCR string representation of the given nodeId.

Returns:

a JCR node identifier string.

See Also:

fromJcrIdentifier(String)

fromJcrIdentifier

NodeId fromJcrIdentifier(String jcrIdentifier)

Create a new NodeId from the given JCR string representation.

Parameters:

jcrIdentifier -

Returns:

a new NodeId.

See Also:

toJcrIdentifier(NodeId)