org.sakaiproject.hierarchy

Interface HierarchyNodeReader

All Known Subinterfaces:

HierarchyProvider, HierarchyService

public interface HierarchyNodeReader

Allows user to get hierarchical node data from the hierarchy

Author:

Aaron Zeckoski (aaronz@vt.edu)

Method Summary

Modifier and Type	Method and Description
Set<HierarchyNode>	getChildNodes(String nodeId, boolean directOnly) Get all children nodes for this node in the hierarchy all the way to the leaves, will return no nodes if this node has no children
HierarchyNode	getNodeById(String nodeId) Get a node based on the unique id, convenience method for getNodesByIds(String[])
Map<String,HierarchyNode>	getNodesByIds(String[] nodeIds) Get a set of nodes based on their unique ids, NOTE: this method is here for efficiency
Set<HierarchyNode>	getParentNodes(String nodeId, boolean directOnly) Get all the parent nodes for a specific node all the way to the root node, returns empty set if this is the root node
HierarchyNode	getRootNode(String hierarchyId) Get the hierarchy root node for a specific hierarchy if it exists

Method Detail

getRootNode

HierarchyNode getRootNode(String hierarchyId)

Get the hierarchy root node for a specific hierarchy if it exists

Parameters:

hierarchyId - a unique string which identifies this hierarchy

Returns:

the HierarchyNode representing the root of the hierarchy if found, otherwise returns a null

getNodeById

HierarchyNode getNodeById(String nodeId)

Get a node based on the unique id, convenience method for getNodesByIds(String[])

Parameters:

nodeId - a unique id for a hierarchy node

Returns:

the HierarchyNode representing this node or null if it does not exist

getNodesByIds

Map<String,HierarchyNode> getNodesByIds(String[] nodeIds)

Get a set of nodes based on their unique ids, NOTE: this method is here for efficiency

Parameters:

nodeIds - unique ids for hierarchy nodes

Returns:

a map of nodeId -> HierarchyNode

getParentNodes

Set<HierarchyNode> getParentNodes(String nodeId,
                                  boolean directOnly)

Get all the parent nodes for a specific node all the way to the root node, returns empty set if this is the root node

Parameters:

nodeId - a unique id for a hierarchy node

directOnly - if true then only include the nodes which are directly connected to this node, else return every node that is a parent of this node

Returns:

a Set of HierarchyNode objects representing all parent nodes for the specified child, empty set if no parents found

getChildNodes

Set<HierarchyNode> getChildNodes(String nodeId,
                                 boolean directOnly)

Get all children nodes for this node in the hierarchy all the way to the leaves, will return no nodes if this node has no children

Parameters:

nodeId - a unique id for a hierarchy node

directOnly - if true then only include the nodes which are directly connected to this node, else return every node that is a child of this node

Returns:

a Set of HierarchyNode objects representing all children nodes for the specified parent, empty set if no children found