|
||||||||||
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. |
HierarchyEntry |
getHierarchyEntry(ItemId itemId)
Resolves a itemId into a HierarchyEntry . |
HierarchyEntry |
getHierarchyEntry(Path qPath)
Resolves a path into a HierarchyEntry . |
ItemState |
getItemState(Path qPath)
Retrieves the HierarchyEntry corresponding to the given
path and resolves it to the underlying ItemState . |
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 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 . |
Method Detail |
---|
void dispose()
HierarchyManager
NodeEntry getRootEntry()
HierarchyEntry lookup(ItemId workspaceItemId)
HierarchyEntry
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 getHierarchyEntry(ItemId)
for a method that resolves the ItemId including lookup in the persistence
layer if the entry has not been loaded yet.
workspaceItemId
-
HierarchyEntry getHierarchyEntry(ItemId itemId) throws ItemNotFoundException, RepositoryException
HierarchyEntry
.
itemId
-
PathNotFoundException
RepositoryException
ItemNotFoundException
HierarchyEntry getHierarchyEntry(Path qPath) throws PathNotFoundException, RepositoryException
HierarchyEntry
.
qPath
-
PathNotFoundException
RepositoryException
ItemState getItemState(Path qPath) throws PathNotFoundException, RepositoryException
HierarchyEntry
corresponding to the given
path and resolves it to the underlying ItemState
.
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 |