org.ai_heuristic.tree

Class TreeNode

java.lang.Object

org.ai_heuristic.tree.TreeNode

Direct Known Subclasses:

KD_TreeNode, Tree

public class TreeNode
extends java.lang.Object

This class can be used as the base for any node structure.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.String>	childNodeKeys List of child node keys, in the correct order.
protected java.util.HashMap<java.lang.String,TreeNode>	childNodes List of nodes that branch from this node.
protected float	count Frequency count for anything, for this node's value.
protected java.lang.String	name A unique name or ID for the node
protected TreeNode	parent The parent TreeNode.
protected MetricDataset	value The specific value for this node
protected java.lang.String	valueType The type of value that this node supports

Constructor Summary

Constructors

Constructor and Description
TreeNode(java.lang.String theValueType) Create a new instance of TreeNode.
TreeNode(java.lang.String theValueType, MetricDataset theValue) Create a new instance of TreeNode.
TreeNode(java.lang.String theName, java.lang.String theValueType) Create a new instance of TreeNode.
TreeNode(java.lang.String theName, java.lang.String theValueType, MetricDataset theValue) Create a new instance of TreeNode.

Method Summary

Modifier and Type	Method and Description
boolean	addChildNode(TreeNode childNode) Add a child node to this node.
boolean	addChildNode(TreeNode childNode, int index) Add a child node to this node.
void	clearChildNodes() Clear the child nodes of this node.
java.lang.Object	clone() Clone and return a copy of this object.
TreeNode	getChildNode(java.lang.String nodeName) Get the child node with the specified name.
TreeNode	getChildNodeDeep(java.lang.String nodeName) Get the child node at any sub-tree branch with the specified name.
java.util.ArrayList<java.lang.String>	getChildNodeKeys() Get the list of ordered child node keys.
java.util.HashMap<java.lang.String,TreeNode>	getChildNodes() Get the list of child nodes.
TreeNode	getChildNodeValue(java.lang.Object theValue) Return the child node with the specified value if it exists.
TreeNode	getChildNodeValueDeep(java.lang.Object theValue) Return the child node with the specified value anywhere in the tree if it exists.
float	getCount() Get the count value, frequency or something else.
java.lang.String	getName() Get the node id or name.
TreeNode	getParent() Get the parent tree node.
java.lang.Object	getValue() Get the actual node value, not the enclosing MetricValue object.
java.lang.String	getValueType() Get the node value type.
java.lang.String	getValueTypeMD() Get the metric dataset value type, which is set when the MetricDataset is created.
boolean	hasChildNode(java.lang.String nodeName) Return true if a child node with the specified name exists.
boolean	hasChildNodeDeep(java.lang.String nodeName) Return true if a child node at any sub-tree branch with the specified name exists.
boolean	hasChildNodes() Return true if this node has child nodes.
boolean	hasChildNodeValue(java.lang.Object theValue) Return true if a child node with the specified value exists.
boolean	hasChildNodeValueDeep(java.lang.Object theValue) Return true if a child node with the specified value exists.
boolean	hasValue(java.lang.Object theValue) Return true if the value of this node is the same as the value passed in.
boolean	isLeaf() Return true if a leaf node.
int	maxDepth() Get the maximum tree depth for any branch.
java.util.ArrayList<TreeNode>	nodesAtLevel(int level) Get a list of all nodes at a particular level in the tree, across all branches.
boolean	removeChildNode(java.lang.String nodeName) Remove the child node with the specified name.
void	setChildNodes(java.util.ArrayList<java.lang.String> keyList, java.util.HashMap<java.lang.String,TreeNode> thisChildNodes) Set the full list of child nodes, replacing any existing list.
void	setChildNodes(java.util.HashMap<java.lang.String,TreeNode> thisChildNodes) Set the full list of child nodes, replacing any existing list.
void	setCount(float thisCount) Set the count value, frequency or something else.
void	setParent(TreeNode theParent) Set the node parent.
void	setValue(MetricDataset theValue) Set the node value.
java.lang.String	toString() Return a string-based description of the node branch.
protected java.lang.String	toString(TreeNode rootNode, java.lang.String indent, java.util.ArrayList<java.lang.String> alreadySearched) Return a string-based description of the node branch.
java.lang.String	treeValueDeep() Traverse this tree structure and add a description of all value elements that are not null or empty.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

A unique name or ID for the node

valueType

protected java.lang.String valueType

The type of value that this node supports

value

protected MetricDataset value

The specific value for this node

count

protected float count

Frequency count for anything, for this node's value. Set to 0 when the value is initialised.

childNodeKeys

protected java.util.ArrayList<java.lang.String> childNodeKeys

List of child node keys, in the correct order.

childNodes

protected java.util.HashMap<java.lang.String,TreeNode> childNodes

List of nodes that branch from this node. Key is the node name and value is of type TreeNode.

parent

protected TreeNode parent

The parent TreeNode.

Constructor Detail

TreeNode

public TreeNode(java.lang.String theValueType)
         throws java.lang.Exception

Create a new instance of TreeNode. The name is assigned a unique value.

Parameters:

theValueType - the type of value that this node supports.

Throws:

java.lang.Exception - any error.

TreeNode

public TreeNode(java.lang.String theName,
                java.lang.String theValueType)

Create a new instance of TreeNode.

Parameters:

theName - a unique name or ID for the node.

theValueType - the type of value that this node supports.

TreeNode

public TreeNode(java.lang.String theValueType,
                MetricDataset theValue)
         throws java.lang.Exception

Create a new instance of TreeNode. The name is assigned a unique value.

Parameters:

theValueType - the type of value that this node supports.

theValue - the specific value for this node.

Throws:

java.lang.Exception - any error.

TreeNode

public TreeNode(java.lang.String theName,
                java.lang.String theValueType,
                MetricDataset theValue)

Create a new instance of TreeNode.

Parameters:

theName - a unique name or ID for the node.

theValueType - the type of value that this node supports.

theValue - the specific value for this node.

Method Detail

isLeaf

public boolean isLeaf()

Return true if a leaf node.

Returns:

true if childNodes is empty.

hasChildNodes

public boolean hasChildNodes()

Return true if this node has child nodes.

Returns:

true if childNodes is not empty.

hasChildNode

public boolean hasChildNode(java.lang.String nodeName)

Return true if a child node with the specified name exists.

Parameters:

nodeName - the name of the node to check for.

Returns:

true if a child node with the name exists.

hasValue

public boolean hasValue(java.lang.Object theValue)
                 throws java.lang.Exception

Return true if the value of this node is the same as the value passed in. The SimpleMathCompare.mathCompare method is used to make an equivalence comparison. A numerical or String value is evaluated as is. Lists are compared across individual elements, where this list should contain the input list.

Parameters:

theValue - the node value to check for.

Returns:

true if the value is the same as the value of this node.

Throws:

java.lang.Exception - any error.

hasChildNodeValue

public boolean hasChildNodeValue(java.lang.Object theValue)
                          throws java.lang.Exception

Return true if a child node with the specified value exists.

Parameters:

theValue - the node value to check for.

Returns:

true if a child node with the name exists.

Throws:

java.lang.Exception - any error.

maxDepth

public int maxDepth()

Get the maximum tree depth for any branch.

Returns:

maximum depth of any branch.

nodesAtLevel

public java.util.ArrayList<TreeNode> nodesAtLevel(int level)

Get a list of all nodes at a particular level in the tree, across all branches.

Parameters:

level - the tree level, starting at 0, for this node.

Returns:

a list of all nodes at that level, or empty if the level is too high.

treeValueDeep

public java.lang.String treeValueDeep()

Traverse this tree structure and add a description of all value elements that are not null or empty.

Returns:

all tree node values concatenated together.

hasChildNodeDeep

public boolean hasChildNodeDeep(java.lang.String nodeName)
                         throws java.lang.Exception

Return true if a child node at any sub-tree branch with the specified name exists.

Parameters:

nodeName - the name of the node to check for.

Returns:

true if a child node with the name exists anywhere in this tree.

Throws:

java.lang.Exception - any error.

hasChildNodeValueDeep

public boolean hasChildNodeValueDeep(java.lang.Object theValue)
                              throws java.lang.Exception

Return true if a child node with the specified value exists. The SimpleMathCompare.mathCompare method is used to make an equivalence comparison. A numerical or String value is evaluated as is. Any other type is converted to a String using EvaluateBase.valueToString and that is used instead.

Parameters:

theValue - the node value to check for.

Returns:

true if a child node with the name value anywhere in this tree.

Throws:

java.lang.Exception - any error.

getChildNodeDeep

public TreeNode getChildNodeDeep(java.lang.String nodeName)
                          throws java.lang.Exception

Get the child node at any sub-tree branch with the specified name.

Parameters:

nodeName - the name of the node to check for.

Returns:

the child node with the name anywhere in this tree, or null if it does not exist.

Throws:

java.lang.Exception - any error.

getChildNodeValue

public TreeNode getChildNodeValue(java.lang.Object theValue)
                           throws java.lang.Exception

Return the child node with the specified value if it exists. The SimpleMathCompare.mathCompare method is used to make an equivalence comparison. A numerical or String value is evaluated as is. Any other type is converted to a String using EvaluateBase.valueToString and that is used instead.

Parameters:

theValue - the node value to check for.

Returns:

the child node with the name value anywhere in this tree.

Throws:

java.lang.Exception - any error.

getChildNodeValueDeep

public TreeNode getChildNodeValueDeep(java.lang.Object theValue)
                               throws java.lang.Exception

Return the child node with the specified value anywhere in the tree if it exists. The SimpleMathCompare.mathCompare method is used to make an equivalence comparison. A numerical or String value is evaluated as is. Any other type is converted to a String using EvaluateBase.valueToString and that is used instead.

Parameters:

theValue - the value to match with.

Returns:

the child node with the name anywhere in this tree, or null if it does not exist.

Throws:

java.lang.Exception - any error.

getName

public java.lang.String getName()

Get the node id or name.

Returns:

the value of name.

getValueType

public java.lang.String getValueType()

Get the node value type.

Returns:

the value of valueType.

getValueTypeMD

public java.lang.String getValueTypeMD()

Get the metric dataset value type, which is set when the MetricDataset is created. This can be different to the node value type, if it stores node values in a list, for example.

Returns:

the value of value.getValueType.

setCount

public void setCount(float thisCount)

Set the count value, frequency or something else.

Parameters:

thisCount - value of count.

getCount

public float getCount()

Get the count value, frequency or something else.

Returns:

the value of count.

setValue

public void setValue(MetricDataset theValue)

Set the node value.

Parameters:

theValue - the node value. Of type valueType.

getValue

public java.lang.Object getValue()

Get the actual node value, not the enclosing MetricValue object.

Returns:

an ArrayList of values, or single value using value.getFirstValue(), or null for no value.

getChildNode

public TreeNode getChildNode(java.lang.String nodeName)

Get the child node with the specified name.

Parameters:

nodeName - the name of the child node to retrieve.

Returns:

the child node with the specified name, of null if none exist.

getChildNodeKeys

public java.util.ArrayList<java.lang.String> getChildNodeKeys()

Get the list of ordered child node keys.

Returns:

the value of getChildNodeKeys.

addChildNode

public boolean addChildNode(TreeNode childNode)

Add a child node to this node. The new node must have a unique id in all of the child nodes of this node only. The key is added to the end of the list.

Parameters:

childNode - the node to add.

Returns:

true if added, false if a node with the name already exists.

addChildNode

public boolean addChildNode(TreeNode childNode,
                            int index)

Add a child node to this node. The new node must have a unique id in all of the child nodes of this node only. The key is added to the list at position index.

Parameters:

childNode - the node to add.

index - the position in the ordered list to add the node. If larger than the list, add at the end.

Returns:

true if added, false if a node with the name already exists.

removeChildNode

public boolean removeChildNode(java.lang.String nodeName)

Remove the child node with the specified name.

Parameters:

nodeName - the name of the node to remove.

Returns:

true if removed, false if it does not exist.

clearChildNodes

public void clearChildNodes()

Clear the child nodes of this node.

setChildNodes

public void setChildNodes(java.util.HashMap<java.lang.String,TreeNode> thisChildNodes)

Set the full list of child nodes, replacing any existing list. An ordered key list is automatically created from the hashtable keyset, but the hashtable ordering may be arbitrary.

Parameters:

thisChildNodes - the list of child nodes.

setChildNodes

public void setChildNodes(java.util.ArrayList<java.lang.String> keyList,
                          java.util.HashMap<java.lang.String,TreeNode> thisChildNodes)

Set the full list of child nodes, replacing any existing list.

Parameters:

keyList - ordered list of keys. This is the ordering for the tree values.

thisChildNodes - the list of child nodes.

getChildNodes

public java.util.HashMap<java.lang.String,TreeNode> getChildNodes()

Get the list of child nodes. NOTE: using this and then adding to it will not update the childNodeKeys.

Returns:

the value of childNodes.

setParent

public void setParent(TreeNode theParent)

Set the node parent.

Parameters:

theParent - the node's parent node.

getParent

public TreeNode getParent()

Get the parent tree node.

Returns:

the value of parent.

toString

public java.lang.String toString()

Return a string-based description of the node branch.

Overrides:

toString in class java.lang.Object

Returns:

a description of this node and its child nodes.

toString

protected java.lang.String toString(TreeNode rootNode,
                                    java.lang.String indent,
                                    java.util.ArrayList<java.lang.String> alreadySearched)

Return a string-based description of the node branch.

Parameters:

rootNode - the root node to start from.

indent - amount to indent string by.

alreadySearched - list of nodes already searched, in case of cycling.

Returns:

a description of this node and its child nodes.

clone

public java.lang.Object clone()

Clone and return a copy of this object. Child nodes are not cloned.

Overrides:

clone in class java.lang.Object

Returns:

a light copy of this node.