|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HierarchyManager
HierarchyManager
...
Method Summary | |
---|---|
void |
dispose()
Dispose this HierarchyManager |
int |
getDepth(HierarchyEntry hierarchyEntry)
Returns the depth of the specified item. |
NodeEntry |
getNodeEntry(NodeId nodeId)
Resolves a itemId into a HierarchyEntry . |
NodeEntry |
getNodeEntry(Path qPath)
Resolves a path into a NodeEntry . |
NodeState |
getNodeState(Path qPath)
Retrieves the NodeEntry corresponding to the given
path and resolves it to the underlying NodeState . |
PropertyEntry |
getPropertyEntry(Path qPath)
Resolves a path into a PropertyEntry . |
PropertyEntry |
getPropertyEntry(PropertyId propertyId)
Resolves a propertyId into a PropertyEntry . |
PropertyState |
getPropertyState(Path qPath)
Retrieves the PropertyEntry corresponding to the given
path and resolves it to the underlying PropertyState . |
int |
getRelativeDepth(NodeEntry ancestor,
HierarchyEntry descendant)
Returns the depth of the specified descendant relative to the given ancestor. |
NodeEntry |
getRootEntry()
|
HierarchyEntry |
lookup(ItemId workspaceItemId)
Lookup of HierarchyEntry by its workspace Id that may be different
if a entry (or any of its ancestors) has been transiently moved or
reordered. |
HierarchyEntry |
lookup(Path workspacePath)
Lookup of HierarchyEntry by its workspace path that may be different
if a entry (or any of its ancestors) has been transiently moved or
reordered. |
Method Detail |
---|
void dispose()
HierarchyManager
NodeEntry getRootEntry()
HierarchyEntry lookup(ItemId workspaceItemId)
HierarchyEntry
by its workspace Id that may be different
if a entry (or any of its ancestors) has been transiently moved or
reordered.
If the Hierarchy already lists the entry with the given workspaceItemId it is
returned otherwise null
. See getNodeEntry(NodeId)
or getPropertyEntry(PropertyId)
for methods that resolves the
ItemId including lookup in the persistence layer if the entry has not been
loaded yet.
workspaceItemId
-
HierarchyEntry lookup(Path workspacePath)
HierarchyEntry
by its workspace path that may be different
if a entry (or any of its ancestors) has been transiently moved or
reordered.
If the Hierarchy already lists the entry with the given path it is
returned otherwise null
. See getNodeEntry(Path)
or getPropertyEntry(Path)
for methods that resolves the path
including lookup in the persistence layer if the entry has not been loaded yet.
workspaceItemId
-
NodeEntry getNodeEntry(NodeId nodeId) throws ItemNotFoundException, RepositoryException
HierarchyEntry
.
nodeId
-
PathNotFoundException
RepositoryException
ItemNotFoundException
NodeEntry getNodeEntry(Path qPath) throws PathNotFoundException, RepositoryException
NodeEntry
.
qPath
-
PathNotFoundException
RepositoryException
PropertyEntry getPropertyEntry(PropertyId propertyId) throws ItemNotFoundException, RepositoryException
PropertyEntry
.
propertyId
-
PathNotFoundException
RepositoryException
ItemNotFoundException
PropertyEntry getPropertyEntry(Path qPath) throws PathNotFoundException, RepositoryException
PropertyEntry
.
qPath
-
PathNotFoundException
RepositoryException
NodeState getNodeState(Path qPath) throws PathNotFoundException, RepositoryException
NodeEntry
corresponding to the given
path and resolves it to the underlying NodeState
.
qPath
-
PathNotFoundException
RepositoryException
PropertyState getPropertyState(Path qPath) throws PathNotFoundException, RepositoryException
PropertyEntry
corresponding to the given
path and resolves it to the underlying PropertyState
.
qPath
-
PathNotFoundException
RepositoryException
int getDepth(HierarchyEntry hierarchyEntry) throws ItemNotFoundException, RepositoryException
hierarchyEntry
-
RepositoryException
- if another error occurs
ItemNotFoundException
int getRelativeDepth(NodeEntry ancestor, HierarchyEntry descendant) throws ItemNotFoundException, RepositoryException
ancestor
and descendant
denote the same item 0 is returned. If ancestor
does not
denote an ancestor -1 is returned.
ancestor
- NodeEntry that must be an ancestor of the descendantdescendant
- HierarchyEntry
ancestor
does not
denote an ancestor of the item denoted by descendant
(or itself).
ItemNotFoundException
- If either of the specified id's does not
denote an existing item.
RepositoryException
- If another error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |