Interface Tree

All Known Subinterfaces:

AnimatingTree, AnimatingTreeHead, DrawingTree, DrawingTreeHead, TreeHead

All Known Implementing Classes:

BSTTree, BSTTreeHead

public interface Tree

A rooted Tree, where every node is pointed to by just one other node, which is called its parent.

A Tree represents a group of objects, known as its elements, each with its corresponding key. The key maps the value of each node and is used as a comparator. The Tree collection is similiar to a Map, except that duplicate keys are allowed.

Method Summary

Tree[]	getChildren() Returns the children of the current Tree.
java.lang.Comparable	getKey() Returns the key of the current Tree.
int	getLevel() Gets the the level of the Tree.
Tree	getParentTree() Returns the parent of the current Tree.
java.lang.Object	getValue() Returns the value of the current Tree.
boolean	isEmpty() Returns true if the current Tree is empty.
int	size() Returns the number of objects in the current Tree.

Method Detail

size

public int size()

Returns the number of objects in the current Tree.

Returns:

the number of objects in the current Tree.

isEmpty

public boolean isEmpty()

Returns true if the current Tree is empty.

Returns:

true if the Tree is empty.

getValue

public java.lang.Object getValue()

Returns the value of the current Tree.

Returns:

the value of the current Tree.

getKey

public java.lang.Comparable getKey()

Returns the key of the current Tree.

Returns:

the key of the current Tree.

getLevel

public int getLevel()

Gets the the level of the Tree. The level is the integer count of how far down in the tree the current node is.

Returns:

integer count of the level of the current Tree.

getParentTree

public Tree getParentTree()

Returns the parent of the current Tree.

Returns:

Tree that is the parent and null if the tree is the head.

getChildren

public Tree[] getChildren()

Returns the children of the current Tree.

Returns:

Tree array that is the children and null if the tree is an exterior node.