cern.gp.nodes.children

Interface NodeCollection

All Known Subinterfaces:

NodeList, NodeMap

public interface NodeCollection

A class implementing this interface hold a collection of nodes.

The nodes can be organized hierarchically so that a given collection can have a parent node. In this case, the collection is the children of that parent node. Any node of the collection can be either a leaf or a parent node of another collection.

A NodeCollection is managed by a ChildrenManager that control the addition and removal of nodes.

A NodeCollection can be ordered or not. If the collection is ordered and if the sorting criteria is dynamically changed, it is necessary to refresh the ordering of the collection using the method refreshOrdering.

Author:

Lionel Mestre

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all nodes from this collection
GPNode	findChildByName(java.lang.String name) Finds a child node by name.
ChildrenManager	getChildrenManager() Returns the ChildrenManager this collection is managed with
int	getNodesCount() Gets the number of nodes in the collection.
GPNode	getParentNode() Gets the parent node of this collection of children
void	refreshOrdering() Signal this collection that it should refresh the ordering of its member using the sorting mecanism already in place.

Method Detail

refreshOrdering

void refreshOrdering()

Signal this collection that it should refresh the ordering of its member using the sorting mecanism already in place. This method should only be called in the case the collection is ordered and the ordering criteria has been dynamically updated. The method should not have any effect in case the collection is not already sorted.

getParentNode

GPNode getParentNode()

Gets the parent node of this collection of children

Returns:

the parent node of those children

getChildrenManager

ChildrenManager getChildrenManager()

Returns the ChildrenManager this collection is managed with

Returns:

the ChildrenManager this collection is managed with

getNodesCount

int getNodesCount()

Gets the number of nodes in the collection.

Returns:

the count

findChildByName

GPNode findChildByName(java.lang.String name)

Finds a child node by name.

Parameters:

name - the name of the child node to find or null if any arbitrary child may be returned

Returns:

return the node or null if it could not be found

clear

void clear()

Removes all nodes from this collection