org.xmcda

Class CriteriaSetHierarchyNode

java.lang.Object

org.xmcda.CriteriaSetHierarchyNode

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CriteriaSetsHierarchy

public class CriteriaSetHierarchyNode
extends Object
implements Serializable

A node of a hierarchy of criteria, representing a criterion and its getChildren().

Author:

Sébastien Bigaret

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG

Constructor Summary

Constructors

Constructor and Description
CriteriaSetHierarchyNode(CriteriaSet aCriteriaSet) Builds a new node.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(CriteriaSet aCriteriaSet) Adds a child to this node if the criterion is not already registered as a child.
boolean	addChild(CriteriaSetHierarchyNode aNode) Adds a child to this node if its criteriaSet is not already registered as a child.
CriteriaSetHierarchyNode	deepCopy() Returns a deep copy of this node.
CriteriaSetHierarchyNode	getChild(CriteriaSet aCriteriaSet) Returns the child node for the supplied criteria set.
CriteriaSetHierarchyNode	getChild(String aCriteriaSetID) Returns the child node with the supplied criteria set ID.
Set<CriteriaSetHierarchyNode>	getChildren() Returns the children of this node.
CriteriaSet	getCriteriaSet() Returns the criteriaSet attached to this node.
boolean	isLeaf()
boolean	removeChild(CriteriaSet aCriteriaSet) Removes from this node's children the child whose criteriaSet is the one supplied.
boolean	removeChild(CriteriaSetHierarchyNode aChild) Removes a child from this node's children.
String	toString()
protected String	toString(String start, String end)

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final String TAG

See Also:

Constant Field Values

Constructor Detail

CriteriaSetHierarchyNode

public CriteriaSetHierarchyNode(CriteriaSet aCriteriaSet)

Builds a new node.

Parameters:

aCriteriaSet - the criteriaSet attached to the new node

Method Detail

getCriteriaSet

public CriteriaSet getCriteriaSet()

Returns the criteriaSet attached to this node.

Returns:

the criteriaSet for this node.

addChild

public boolean addChild(CriteriaSetHierarchyNode aNode)

Adds a child to this node if its criteriaSet is not already registered as a child.

Parameters:

aNode - the node to be added

Returns:

true if this node did not already contain the specified node's criteriaSet in its children.

addChild

public boolean addChild(CriteriaSet aCriteriaSet)

Adds a child to this node if the criterion is not already registered as a child.

Parameters:

aNode - the node to be added

Returns:

true if the node did not already contain the criterion in its children.

removeChild

public boolean removeChild(CriteriaSetHierarchyNode aChild)

Removes a child from this node's children.

Parameters:

aChild - the node to be removed.

Returns:

true if the element was removed, false if it was not in this node's children.

removeChild

public boolean removeChild(CriteriaSet aCriteriaSet)

Removes from this node's children the child whose criteriaSet is the one supplied.

Parameters:

aChild - the criteriaSet for the node to be removed.

Returns:

true if the corresponding child could be found and removed.

getChildren

public Set<CriteriaSetHierarchyNode> getChildren()

Returns the children of this node. The returned set is unmodifiable, however if you add or remove children from one of the returned set's nodes, this will directly change the sub-hierarchy held by this node as well. If you want to manipulate the hierarchy of the returned nodes without affecting this node's hierarchy, call deepCopy() on this object and then call this method on the copy instead.

Returns:

this node's children.

getChild

public CriteriaSetHierarchyNode getChild(CriteriaSet aCriteriaSet)

Returns the child node for the supplied criteria set.

Parameters:

aCriteriaSet - the criterion to search in this node's children

Returns:

the corresponding child node, or null if no such child could be found.

getChild

public CriteriaSetHierarchyNode getChild(String aCriteriaSetID)

Returns the child node with the supplied criteria set ID.

Parameters:

aCriterionSetID - the ID of a criteriaSet to search in this node's children

Returns:

the corresponding child node, or null if no such child could be found.

isLeaf

public boolean isLeaf()

deepCopy

public CriteriaSetHierarchyNode deepCopy()

Returns a deep copy of this node. The returned node and its children, and their children etc. can then be modified without affecting this node and the hierarchy underneath.

Returns:

a deep copy of this node.

toString

public String toString()

Overrides:

toString in class Object

toString

protected String toString(String start,
                          String end)