org.ai_heuristic.tree

Class Tree

java.lang.Object

org.ai_heuristic.tree.TreeNode

org.ai_heuristic.tree.Tree

public class Tree
extends TreeNode

This class can be used to build a tree-like structure, representing arbitrary information. Use this as the base node of any structure, to store child node, but without any value itself.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.tree.TreeNode

childNodeKeys, childNodes, count, name, parent, value, valueType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearTree() Clear the whole tree by removing all child nodes.
java.lang.Object	clone() Clone and return a copy of this object.
java.lang.String	toString() Return a string-based description of the node branch.

Methods inherited from class org.ai_heuristic.tree.TreeNode

addChildNode, addChildNode, clearChildNodes, getChildNode, getChildNodeDeep, getChildNodeKeys, getChildNodes, getChildNodeValue, getChildNodeValueDeep, getCount, getName, getParent, getValue, getValueType, getValueTypeMD, hasChildNode, hasChildNodeDeep, hasChildNodes, hasChildNodeValue, hasChildNodeValueDeep, hasValue, isLeaf, maxDepth, nodesAtLevel, removeChildNode, setChildNodes, setChildNodes, setCount, setParent, setValue, toString, treeValueDeep

Methods inherited from class java.lang.Object

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

Constructor Detail

Tree

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

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

Parameters:

theValueType - the type of value that this node supports.

Throws:

java.lang.Exception - any error.

Tree

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

Create a new instance of Tree.

Parameters:

theName - a unique name or ID for the tree.

theValueType - the tree value type.

Method Detail

clearTree

public void clearTree()

Clear the whole tree by removing all child nodes.

toString

public java.lang.String toString()

Return a string-based description of the node branch.

Overrides:

toString in class TreeNode

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 TreeNode

Returns:

a light copy of this node.