org.xmcda

Class CriteriaHierarchy

java.lang.Object

org.xmcda.CriterionHierarchyNode

org.xmcda.CriteriaHierarchy

All Implemented Interfaces:

Serializable, CommonAttributes, HasDescription, XMCDARootElement

public class CriteriaHierarchy
extends CriterionHierarchyNode
implements HasDescription, CommonAttributes, XMCDARootElement, Serializable

A hierarchy of criteria.

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
CriteriaHierarchy()

Method Summary

Modifier and Type	Method and Description
boolean	addRoot(Criterion aCriterion) Adds a child to this node if the criterion is not already registered as a root node.
boolean	addRoot(CriterionHierarchyNode rootNode) Adds a root node to this hierarchy if its criterion is not already registered in an registered root node.
Criterion	getCriterion() Returns null.
Description	getDescription()
Set<CriterionHierarchyNode>	getRootNodes() Returns the root nodes of this hierarchy.
String	id()
String	mcdaConcept()
String	name()
boolean	removeRoot(Criterion rootCriterion) Removes from this hierarchy the root whose criterion is the one supplied.
boolean	removeRoot(CriterionHierarchyNode rootNode) Removes a root node from this node's children. This is an alias to CriterionHierarchyNode.removeChild(CriterionHierarchyNode).
void	setDescription(Description description)
void	setId(String id)
void	setMcdaConcept(String mcdaConcept)
void	setName(String name)
String	toString()

Methods inherited from class org.xmcda.CriterionHierarchyNode

addChild, addChild, deepCopy, getChild, getChild, getChildren, isLeaf, removeChild, removeChild, toString

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

CriteriaHierarchy

public CriteriaHierarchy()

Method Detail

getCriterion

public Criterion getCriterion()

Returns null.

Overrides:

getCriterion in class CriterionHierarchyNode

Returns:

the criterion for this node.

id

public String id()

Specified by:

id in interface CommonAttributes

setId

public void setId(String id)

Specified by:

setId in interface CommonAttributes

name

public String name()

Specified by:

name in interface CommonAttributes

mcdaConcept

public String mcdaConcept()

Specified by:

mcdaConcept in interface CommonAttributes

setName

public void setName(String name)

Specified by:

setName in interface CommonAttributes

setMcdaConcept

public void setMcdaConcept(String mcdaConcept)

Specified by:

setMcdaConcept in interface CommonAttributes

setDescription

public void setDescription(Description description)

Specified by:

setDescription in interface HasDescription

getDescription

public Description getDescription()

Specified by:

getDescription in interface HasDescription

getRootNodes

public Set<CriterionHierarchyNode> getRootNodes()

Returns the root nodes of this hierarchy. The returned set is unmodifiable, however if you add or remove children from one of the returned root nodes, this will directly change this hierarchy as well. If you want to manipulate the hierarchy of the returned root nodes without affecting this hierarchy, call CriterionHierarchyNode.deepCopy() on this object and then call this method on the copy instead.
This is an alias to CriterionHierarchyNode.getChildren().

Returns:

the roots of this hierarchy.

addRoot

public boolean addRoot(CriterionHierarchyNode rootNode)

Adds a root node to this hierarchy if its criterion is not already registered in an registered root node.
This is an alias to CriterionHierarchyNode.addChild(Criterion)

Parameters:

rootNode - the root node to be added to this hierarchy.

Returns:

addRoot

public boolean addRoot(Criterion aCriterion)

Adds a child to this node if the criterion is not already registered as a root node.
This is an alias to CriterionHierarchyNode.addChild(Criterion)

removeRoot

public boolean removeRoot(CriterionHierarchyNode rootNode)

Removes a root node from this node's children.
This is an alias to CriterionHierarchyNode.removeChild(CriterionHierarchyNode).

Parameters:

aChild - the element to be removed.

Returns:

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

removeRoot

public boolean removeRoot(Criterion rootCriterion)

Removes from this hierarchy the root whose criterion is the one supplied.
This is an alias to CriterionHierarchyNode.removeChild(Criterion).

Parameters:

rootCriterion - the criterion for the root to be removed.

Returns:

true if the corresponding root node was found and removed.

toString

public String toString()

Overrides:

toString in class CriterionHierarchyNode