Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

cern::gp::nodes::children::NodeCollection Interface Reference

Inheritance diagram for cern::gp::nodes::children::NodeCollection:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void refreshOrdering ()
GPNode getParentNode ()
ChildrenManager getChildrenManager ()
int getNodesCount ()
GPNode findChildByName (String name)
void clear ()

Detailed Description

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.

Version:
Revision
1.2
Date
2006/09/25 08:52:36
Author:
Lionel Mestre


Member Function Documentation

void cern::gp::nodes::children::NodeCollection::clear  ) 
 

Removes all nodes from this collection

Implemented in cern::gp::nodes::children::ChildrenFactory::ArrayChildren, cern::gp::nodes::children::ChildrenFactory::SortedArrayChildren, cern::gp::nodes::children::ChildrenFactory::MapChildren, and cern::gp::nodes::children::ChildrenFactory::SortedMapChildren.

GPNode cern::gp::nodes::children::NodeCollection::findChildByName String  name  ) 
 

Finds a child node by name.

Parameters:
<code>name</code> 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

Implemented in cern::gp::nodes::children::ChildrenFactory::ArrayChildren, cern::gp::nodes::children::ChildrenFactory::SortedArrayChildren, cern::gp::nodes::children::ChildrenFactory::MapChildren, and cern::gp::nodes::children::ChildrenFactory::SortedMapChildren.

ChildrenManager cern::gp::nodes::children::NodeCollection::getChildrenManager  ) 
 

Returns the ChildrenManager this collection is managed with

Returns:
the ChildrenManager this collection is managed with

Implemented in cern::gp::nodes::children::ChildrenFactory::ArrayChildren, cern::gp::nodes::children::ChildrenFactory::SortedArrayChildren, cern::gp::nodes::children::ChildrenFactory::MapChildren, and cern::gp::nodes::children::ChildrenFactory::SortedMapChildren.

int cern::gp::nodes::children::NodeCollection::getNodesCount  ) 
 

Gets the number of nodes in the collection.

Returns:
the count

GPNode cern::gp::nodes::children::NodeCollection::getParentNode  ) 
 

Gets the parent node of this collection of children

Returns:
the parent node of those children

Implemented in cern::gp::nodes::children::ChildrenFactory::ArrayChildren, cern::gp::nodes::children::ChildrenFactory::SortedArrayChildren, cern::gp::nodes::children::ChildrenFactory::MapChildren, and cern::gp::nodes::children::ChildrenFactory::SortedMapChildren.

void cern::gp::nodes::children::NodeCollection::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.

Implemented in cern::gp::nodes::children::ChildrenFactory::ArrayChildren, cern::gp::nodes::children::ChildrenFactory::SortedArrayChildren, cern::gp::nodes::children::ChildrenFactory::MapChildren, and cern::gp::nodes::children::ChildrenFactory::SortedMapChildren.


The documentation for this interface was generated from the following file:
Generated on Thu Apr 30 03:08:37 2009 for ACS Java API by doxygen 1.3.8