|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jackrabbit.core.HierarchyManagerImpl
org.apache.jackrabbit.core.CachingHierarchyManager
public class CachingHierarchyManager
Implementation of a HierarchyManager
that caches paths of
items.
Field Summary | |
---|---|
static int |
DEFAULT_UPPER_LIMIT
Default upper limit of cached states |
Fields inherited from class org.apache.jackrabbit.core.HierarchyManagerImpl |
---|
provider, rootNodeId |
Constructor Summary | |
---|---|
CachingHierarchyManager(NodeId rootNodeId,
ItemStateManager provider)
Create a new instance of this class. |
Method Summary | |
---|---|
protected void |
buildPath(PathBuilder builder,
ItemState state)
Adds the path element of an item id to the path currently being built. |
void |
dump(PrintStream ps)
Dump contents of path map and elements included to PrintStream given. |
void |
enableConsistencyChecks(boolean enable)
Enable or disable consistency checks in this instance. |
int |
getDepth(ItemId id)
Returns the depth of the specified item which is equivalent to getPath(id).getAncestorCount() . |
Name |
getName(ItemId id)
Returns the name of the specified item. |
Path |
getPath(ItemId id)
Returns the path to the given item. |
boolean |
isAncestor(NodeId nodeId,
ItemId itemId)
Determines whether the node with the specified nodeId
is an ancestor of the item denoted by the given itemId . |
void |
nodeAdded(NodeState state,
Name name,
int index,
NodeId id)
Called when a child node has been added |
void |
nodeModified(NodeState modified)
Called when a node has been modified, typically as a result of removal or addition of a child node. |
void |
nodeRemoved(NodeState state,
Name name,
int index,
NodeId id)
Called when a child node has been removed |
void |
nodesReplaced(NodeState state)
Called when the children nodes were replaced by other nodes, typically as result of a reorder operation. |
protected void |
pathResolved(ItemId id,
PathBuilder builder)
Called by HierarchyManagerImpl.resolvePath(Path.Element[], int, ItemId, int) . |
protected ItemId |
resolvePath(Path path,
int typesAllowed)
Internal implementation of HierarchyManagerImpl.resolvePath(Path) that will either
resolve to a node or a property. |
void |
stateCreated(ItemState created)
Called when an ItemState has successfully
been created (i.e. its underlying persistent state was created). |
void |
stateDestroyed(ItemState destroyed)
Called when an ItemState has successfully been
removed (i.e. its underlying persistent state has been destroyed). |
void |
stateDiscarded(ItemState discarded)
Called when an ItemState has been discarded (i.e. it has
been rendered 'invalid'). |
void |
stateModified(ItemState modified)
Called when an ItemState has successfully
been modified (i.e. its underlying persistent state has changed). |
Methods inherited from class org.apache.jackrabbit.core.HierarchyManagerImpl |
---|
getChildNodeEntry, getChildNodeEntry, getItemState, getName, getParentId, getParentIds, getRelativeDepth, getRootNodeId, getShareRelativeDepth, hasItemState, isShareAncestor, resolveNodePath, resolvePath, resolvePath, resolvePropertyPath |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_UPPER_LIMIT
Constructor Detail |
---|
public CachingHierarchyManager(NodeId rootNodeId, ItemStateManager provider)
rootNodeId
- root node idprovider
- item state managerMethod Detail |
---|
public void enableConsistencyChecks(boolean enable)
enable
- true
to enable consistency checks;
false
to disableprotected ItemId resolvePath(Path path, int typesAllowed) throws RepositoryException
HierarchyManagerImpl.resolvePath(Path)
that will either
resolve to a node or a property. Should be overridden by a subclass
that can resolve an intermediate path into an ItemId
. This
subclass can then invoke HierarchyManagerImpl.resolvePath(Path.Element[], int, ItemId, int)
with a value of next
greater than 1
.
resolvePath
in class HierarchyManagerImpl
path
- path to resolvetypesAllowed
- one of RETURN_ANY
, RETURN_NODE
or RETURN_PROPERTY
null
RepositoryException
- if an error occursprotected void pathResolved(ItemId id, PathBuilder builder) throws MalformedPathException
HierarchyManagerImpl.resolvePath(Path.Element[], int, ItemId, int)
.
May be overridden by some subclass to process/cache intermediate state.
pathResolved
in class HierarchyManagerImpl
id
- id of resolved itembuilder
- path builder containing path resolved
MalformedPathException
- if the path contained in builder
is malformedprotected void buildPath(PathBuilder builder, ItemState state) throws ItemStateException, RepositoryException
builder
contains the path of state
.
Overridden method tries to find a mapping for the intermediate item
state
and add its path elements to the builder currently
being used. If no mapping is found, the item is cached instead after
the base implementation has been invoked.
buildPath
in class HierarchyManagerImpl
builder
- builder currently being usedstate
- item to find path of
ItemStateException
RepositoryException
public Path getPath(ItemId id) throws ItemNotFoundException, RepositoryException
getPath
in interface HierarchyManager
getPath
in class HierarchyManagerImpl
ItemNotFoundException
RepositoryException
public Name getName(ItemId id) throws ItemNotFoundException, RepositoryException
getName
in interface HierarchyManager
getName
in class HierarchyManagerImpl
id
- id of item whose name should be returned
ItemNotFoundException
RepositoryException
public int getDepth(ItemId id) throws ItemNotFoundException, RepositoryException
getPath(id).getAncestorCount()
. The depth reflects the
absolute hierarchy level.
getDepth
in interface HierarchyManager
getDepth
in class HierarchyManagerImpl
id
- item id
ItemNotFoundException
- if the specified id
does not
denote an existing item.
RepositoryException
- if another error occurspublic boolean isAncestor(NodeId nodeId, ItemId itemId) throws ItemNotFoundException, RepositoryException
nodeId
is an ancestor of the item denoted by the given itemId
.
This is equivalent to
getPath(nodeId).isAncestorOf(getPath(itemId))
.
isAncestor
in interface HierarchyManager
isAncestor
in class HierarchyManagerImpl
nodeId
- node iditemId
- item id
true
if the node with the specified
nodeId
is an ancestor of the item denoted by the
given itemId
false otherwise
ItemNotFoundException
- if any of the specified id's does not
denote an existing item.
RepositoryException
- if another error occurspublic void stateCreated(ItemState created)
ItemState
has successfully
been created (i.e. its underlying persistent state was created).
stateCreated
in interface ItemStateListener
created
- the ItemState
that has been 'created'public void stateModified(ItemState modified)
ItemState
has successfully
been modified (i.e. its underlying persistent state has changed).
stateModified
in interface ItemStateListener
modified
- the ItemState
that has been 'modified'public void nodeModified(NodeState modified)
ItemStateListener.stateModified(ItemState)
was called.
If path information is cached for modified
, this iterates
over all child nodes in the path map, evicting the ones that do not
(longer) exist in the underlying NodeState
.
nodeModified
in interface NodeStateListener
modified
- node state that changedpublic void stateDestroyed(ItemState destroyed)
ItemState
has successfully been
removed (i.e. its underlying persistent state has been destroyed).
stateDestroyed
in interface ItemStateListener
destroyed
- the ItemState
that has been 'destroyed'public void stateDiscarded(ItemState discarded)
ItemState
has been discarded (i.e. it has
been rendered 'invalid').
stateDiscarded
in interface ItemStateListener
discarded
- the ItemState
that has been discardedItemState.discard()
public void nodeAdded(NodeState state, Name name, int index, NodeId id)
nodeAdded
in interface NodeStateListener
state
- node state that changedname
- name of node that was addedindex
- index of new nodeid
- id of new nodepublic void nodesReplaced(NodeState state)
nodesReplaced
in interface NodeStateListener
state
- node state that changedpublic void nodeRemoved(NodeState state, Name name, int index, NodeId id)
nodeRemoved
in interface NodeStateListener
state
- node state that changedname
- name of node that was removedindex
- index of removed nodeid
- id of removed nodepublic void dump(PrintStream ps)
PrintStream
given.
dump
in interface Dumpable
ps
- print stream to dump to
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |