org.xmcda

Class CriterionHierarchyNode

java.lang.Object

org.xmcda.CriterionHierarchyNode

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CriteriaHierarchy

public class CriterionHierarchyNode
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
CriterionHierarchyNode(Criterion aCriterion) Builds a new node.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(Criterion aCriterion) Adds a child to this node if the criterion is not already registered as a child.
boolean	addChild(CriterionHierarchyNode aNode) Adds a child to this node if its criterion is not already registered as a child.
CriterionHierarchyNode	deepCopy() Returns a deep copy of this node.
CriterionHierarchyNode	getChild(Criterion aCriterion) Returns the child node for the supplied criterion.
CriterionHierarchyNode	getChild(String aCriterionID) Returns the child node with the supplied criterion ID.
Set<CriterionHierarchyNode>	getChildren() Returns the children of this node.
Criterion	getCriterion() Returns the criterion attached to this node.
boolean	isLeaf()
boolean	removeChild(Criterion aCriterion) Removes from this node's children the child whose criterion is the one supplied.
boolean	removeChild(CriterionHierarchyNode 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

CriterionHierarchyNode

public CriterionHierarchyNode(Criterion aCriterion)

Builds a new node.

Parameters:

aCriterion - the criterion attached to the new node

Method Detail

getCriterion

public Criterion getCriterion()

Returns the criterion attached to this node.

Returns:

the criterion for this node.

addChild

public boolean addChild(CriterionHierarchyNode aNode)

Adds a child to this node if its criterion 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 criterion in its children.

addChild

public boolean addChild(Criterion aCriterion)

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(CriterionHierarchyNode 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(Criterion aCriterion)

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

Parameters:

aChild - the criterion for the node to be removed.

Returns:

true if the corresponding child could be found and removed.

getChildren

public Set<CriterionHierarchyNode> 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 CriterionHierarchyNode getChild(Criterion aCriterion)

Returns the child node for the supplied criterion.

Parameters:

aCriterion - 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 CriterionHierarchyNode getChild(String aCriterionID)

Returns the child node with the supplied criterion ID.

Parameters:

aCriterionID - the ID of a criterion 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 CriterionHierarchyNode 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)