org.apache.jackrabbit.core.virtual
Interface VirtualItemStateProvider

All Superinterfaces:

ItemStateManager

All Known Implementing Classes:

AbstractVISProvider, XAVersionManager

public interface VirtualItemStateProvider

extends ItemStateManager

This Interface defines a virtual item state provider.

Method Summary

VirtualNodeState	createNodeState(VirtualNodeState parent, QName name, NodeId id, QName nodeTypeName) Creates a new virtual node state
VirtualPropertyState	createPropertyState(VirtualNodeState parent, QName name, int type, boolean multiValued) Creats a new virtual property state
NodeId	getVirtualRootId() Returns the id of the root node of the virtual tree.
boolean	isVirtualRoot(ItemId id) Checks if the id refers to the root of a virtual tree.
boolean	setNodeReferences(NodeReferences refs) Informs this provider that the node references to one of its states has changed.

Methods inherited from interface org.apache.jackrabbit.core.state.ItemStateManager

getItemState, getNodeReferences, hasItemState, hasNodeReferences

Method Detail

isVirtualRoot

public boolean isVirtualRoot(ItemId id)

Checks if the id refers to the root of a virtual tree.

Parameters:

id -

Returns:

true if it is the root

getVirtualRootId

public NodeId getVirtualRootId()

Returns the id of the root node of the virtual tree.

Returns:

the id of the root node of the virtual tree.

createPropertyState

public VirtualPropertyState createPropertyState(VirtualNodeState parent,
                                                QName name,
                                                int type,
                                                boolean multiValued)
                                         throws RepositoryException

Creats a new virtual property state

Parameters:

parent -

name -

type -

multiValued -

Returns:

Throws:

RepositoryException

createNodeState

public VirtualNodeState createNodeState(VirtualNodeState parent,
                                        QName name,
                                        NodeId id,
                                        QName nodeTypeName)
                                 throws RepositoryException

Creates a new virtual node state

Parameters:

parent -

name -

id -

nodeTypeName -

Returns:

Throws:

RepositoryException

setNodeReferences

public boolean setNodeReferences(NodeReferences refs)

Informs this provider that the node references to one of its states has changed.

Parameters:

refs -

Returns:

true if the reference target is one of its items.