org.sakaiproject.hierarchy.utils

Class HierarchyUtils

java.lang.Object

org.sakaiproject.hierarchy.utils.HierarchyUtils

public class HierarchyUtils
extends Object

Simple utils to assist with working with the hierarchy

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Constructor Summary

Constructors

Constructor and Description
HierarchyUtils()

Method Summary

Modifier and Type	Method and Description
static List<HierarchyNode>	getSortedNodes(Collection<HierarchyNode> nodes) Create a sorted list of nodes based on a set of input nodes, list goes from root (or highest parent) down to the bottom most node
static Set<String>	getUniqueChildNodes(Collection<HierarchyNode> nodes, boolean includeSuppliedNodeIds, boolean directOnly) Create a set of all the unique child node ids based on the set of supplied nodes, can optionally be limited to return only direct children and to include the supplied node ids
static Set<String>	getUniqueParentNodes(Collection<HierarchyNode> nodes, boolean includeSuppliedNodeIds, boolean directOnly) Create a set of all the unique parent node ids based on the set of supplied nodes, can optionally be limited to return only direct parents and to include the supplied node ids

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HierarchyUtils

public HierarchyUtils()

Method Detail

getSortedNodes

public static List<HierarchyNode> getSortedNodes(Collection<HierarchyNode> nodes)

Create a sorted list of nodes based on a set of input nodes, list goes from root (or highest parent) down to the bottom most node

Parameters:

nodes -

Returns:

a list of HierarchyNode

getUniqueChildNodes

public static Set<String> getUniqueChildNodes(Collection<HierarchyNode> nodes,
                                              boolean includeSuppliedNodeIds,
                                              boolean directOnly)

Create a set of all the unique child node ids based on the set of supplied nodes, can optionally be limited to return only direct children and to include the supplied node ids

Parameters:

nodes - a collection of HierarchyNode

includeSuppliedNodes - includes the nodeIds of the supplied collection of nodes in the returned set

directOnly - only use the direct children of each node

Returns:

the set of all unique child node ids

getUniqueParentNodes

public static Set<String> getUniqueParentNodes(Collection<HierarchyNode> nodes,
                                               boolean includeSuppliedNodeIds,
                                               boolean directOnly)

Create a set of all the unique parent node ids based on the set of supplied nodes, can optionally be limited to return only direct parents and to include the supplied node ids

Parameters:

nodes - a collection of HierarchyNode

includeSuppliedNodes - includes the nodeIds of the supplied collection of nodes in the returned set

directOnly - only use the direct parents of each node

Returns:

the set of all unique parent node ids