prajna.util

Class Tree<L>

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

prajna.util.Tree<L>

Type Parameters:

L - The data type for the node object

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode

public class Tree<L>
extends javax.swing.tree.DefaultMutableTreeNode

Simple extension to DefaultMutableTreeNode which allows typing of the object stored at each node

Author:

Edward Swing

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor and Description
Tree(L data) Instantiates a new tree.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(L data) Adds a child with the specified data to this tree.
boolean	add(L data, L parentData) Adds the child with the specified data to the parent with the specified data.
void	add(javax.swing.tree.MutableTreeNode newChild) Add a new child.
void	add(Tree<L> newChild) Adds a child to this tree
java.util.Iterator<L>	breadthFirstIterator() Breadth first iterator which iterates over the data elements within the tree
java.util.Iterator<L>	depthFirstIterator() Depth first iterator which iterates over the data elements within the tree
boolean	equals(java.lang.Object obj) Returns whether another Tree object equals this one.
Tree<L>	findChild(L data) Find a child tree with the specified data element.
java.util.ArrayList<L>	getChildren() Gets the list of child data elements
java.util.ArrayList<Tree<L>>	getChildTrees() Gets the list of child trees.
L	getData() Gets the typed data object associated with this tree node
int	getLevel(L data) Gets the level of the specified data element
int	hashCode() Get the hash code for this tree
java.util.Iterator<L>	preOrderIterator() Pre-order iterator which iterates over the data elements within the tree
int	size() Return the size of the tree.

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tree

public Tree(L data)

Instantiates a new tree.

Parameters:

data - the data object for the tree

Method Detail

add

public void add(L data)

Adds a child with the specified data to this tree.

Parameters:

data - the data

add

public boolean add(L data,
          L parentData)

Adds the child with the specified data to the parent with the specified data. This method finds the tree node matching the desired parent data. If it is found, the new node is created and added as a child to that node.

Parameters:

data - the child data

parentData - the parent data

Returns:

true if the child was successfully added to the tree, false otherwise

add

public void add(javax.swing.tree.MutableTreeNode newChild)

Add a new child. Since a Tree can only accept other Tree nodes, this method throws an IllegalArgumentException

Overrides:

add in class javax.swing.tree.DefaultMutableTreeNode

Parameters:

newChild - the new child

add

public void add(Tree<L> newChild)

Adds a child to this tree

Parameters:

newChild - the new child

breadthFirstIterator

public java.util.Iterator<L> breadthFirstIterator()

Breadth first iterator which iterates over the data elements within the tree

Returns:

an iterator over the data elements within the tree

depthFirstIterator

public java.util.Iterator<L> depthFirstIterator()

Depth first iterator which iterates over the data elements within the tree

Returns:

an iterator over the data elements within the tree

equals

public boolean equals(java.lang.Object obj)

Returns whether another Tree object equals this one. Two Tree objects are equal if they have the same data object

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to

Returns:

true if the Tree matches the other object, false otherwise.

findChild

public Tree<L> findChild(L data)

Find a child tree with the specified data element.

Parameters:

data - the data element

Returns:

the tree node with the specified data element

getChildren

public java.util.ArrayList<L> getChildren()

Gets the list of child data elements

Returns:

the children

getChildTrees

public java.util.ArrayList<Tree<L>> getChildTrees()

Gets the list of child trees.

Returns:

the child trees

getData

public L getData()

Gets the typed data object associated with this tree node

Returns:

the data object

getLevel

public int getLevel(L data)

Gets the level of the specified data element

Parameters:

data - the data element

Returns:

the level, which is the depth of the tree

hashCode

public int hashCode()

Get the hash code for this tree

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

preOrderIterator

public java.util.Iterator<L> preOrderIterator()

Pre-order iterator which iterates over the data elements within the tree

Returns:

an iterator over the data elements within the tree

size

public int size()

Return the size of the tree. The size of the tree is the total number of nodes - both leaves and branch nodes - contained in this tree. Since the root node itself is a node, this method will always return a size of at least 1.

Returns:

the number of nodes in the tree