Package org.apache.jackrabbit.core.virtual

Interface VirtualItemStateProvider

All Superinterfaces:

ItemStateManager

All Known Implementing Classes:

AbstractVISProvider, InternalXAVersionManager, VirtualNodeTypeStateProvider

public interface VirtualItemStateProvider
extends ItemStateManager

This Interface defines a virtual item state provider.

Method Summary

Modifier and Type	Method	Description
void	addListener(ItemStateListener listener)	Add an ItemStateListener
VirtualNodeState	createNodeState(VirtualNodeState parent, Name name, NodeId id, Name nodeTypeName)	Creates a new virtual node state
VirtualPropertyState	createPropertyState(VirtualNodeState parent, Name name, int type, boolean multiValued)	Creats a new virtual property state
NodeId	getVirtualRootId()	Deprecated. use getVirtualRootIds() instead.
NodeId[]	getVirtualRootIds()	Returns the ids of the root nodes of the virtual tree.
boolean	isVirtualRoot(ItemId id)	Checks if the id refers to the root of a virtual tree.
void	removeListener(ItemStateListener listener)	Remove an ItemStateListener
boolean	setNodeReferences(ChangeLog references)	Informs this provider that the node references to some of its states have changed.

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

getItemState, getNodeReferences, hasItemState, hasNodeReferences

Method Detail

isVirtualRoot

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

@Deprecated
NodeId getVirtualRootId()

Deprecated.

use getVirtualRootIds() instead.

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

Returns:

the id of the root node of the virtual tree.

getVirtualRootIds

NodeId[] getVirtualRootIds()

Returns the ids of the root nodes of the virtual tree.

Returns:

the ids of the roots node of the virtual tree.

createPropertyState

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

Creats a new virtual property state

Parameters:

parent -

name -

type -

multiValued -

Returns:

Throws:

RepositoryException

createNodeState

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

Creates a new virtual node state

Parameters:

parent -

name -

id - (must not be null)

nodeTypeName -

Returns:

Throws:

RepositoryException

setNodeReferences

boolean setNodeReferences(ChangeLog references)

Informs this provider that the node references to some of its states have changed.

Parameters:

references - collection of NodeReferences instances

Returns:

true if the reference target is one of its items.

addListener

void addListener(ItemStateListener listener)

Add an ItemStateListener

Parameters:

listener - the new listener to be informed on modifications

removeListener

void removeListener(ItemStateListener listener)

Remove an ItemStateListener

Parameters:

listener - an existing listener