org.apache.jackrabbit.spi

Interface NodeInfo

All Superinterfaces:

ItemInfo

All Known Implementing Classes:

NodeInfoImpl

public interface NodeInfo
extends ItemInfo

The NodeInfo provides the basic information required to build nodes making up the repository hierarchy.

Note however, that the list of child nodes does not form part of a NodeInfo. It is retrieved by calling RepositoryService.getChildInfos(SessionInfo, NodeId). In case of batch read the child nodes might be part of the returned Iterator.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<ChildInfo>	getChildInfos() Return all ChildInfos of the node represent by this info, an empty iterator if that node doesn't have any child nodes or null if the implementation is not able or for some internal reasons not willing to compute the ChildInfo iterator.
NodeId	getId() Returns the NodeId for the node that is based on this info object.
int	getIndex() Index of the node.
Name[]	getMixins()
Name	getNodetype()
java.util.Iterator<PropertyId>	getPropertyIds()
PropertyId[]	getReferences() Deprecated. Use RepositoryService.getReferences(SessionInfo, NodeId, Name, boolean) instead.

Methods inherited from interface org.apache.jackrabbit.spi.ItemInfo

denotesNode, getPath

Method Detail

getId

NodeId getId()

Returns the NodeId for the node that is based on this info object.

Specified by:

getId in interface ItemInfo

Returns:

identifier for the item that is based on this info object. the id can either be an absolute path or a uniqueID (+ relative path).

See Also:

RepositoryService.getNodeInfo(SessionInfo, NodeId)

getIndex

int getIndex()

Index of the node.

Returns:

the index.

getNodetype

Name getNodetype()

Returns:

Name representing the name of the primary nodetype.

getMixins

Name[] getMixins()

Returns:

Array of Names representing the names of mixin nodetypes. This includes only explicitly assigned mixin nodetypes. It does not include mixin types inherited through the addition of supertypes to the primary type hierarchy. If there are no mixin node types assigned an empty array will be returned.

getReferences

PropertyId[] getReferences()

Deprecated. Use RepositoryService.getReferences(SessionInfo, NodeId, Name, boolean) instead.

Return the Ids of the properties that are referencing the node based on this info object.

Returns:

Ids of the properties that are referencing the node based on this info object or an empty array if the node is not referenceable or no references exist.

See Also:

PropertyInfo.getId()

getPropertyIds

java.util.Iterator<PropertyId> getPropertyIds()

Returns:

Ids of children properties

See Also:

PropertyInfo.getId()

getChildInfos

java.util.Iterator<ChildInfo> getChildInfos()

Return all ChildInfos of the node represent by this info, an empty iterator if that node doesn't have any child nodes or null if the implementation is not able or for some internal reasons not willing to compute the ChildInfo iterator. In the latter case the user of this API must call RepositoryService.getChildInfos(SessionInfo, NodeId) in order to determine the existence and identity of the child nodes.

Returns:

An iterator of ChildInfos or null if the implementation is not able or willing to compute the set of ChildInfos (e.g. an implementation may choose to return null if there is a huge amount of child nodes). In this case RepositoryService.getChildInfos(SessionInfo, NodeId) will be used to load the ChildInfos.