de.unihalle.informatik.MiToBo.core.datatypes

Class MTBTree

java.lang.Object

de.unihalle.informatik.MiToBo.core.datatypes.MTBTree

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DirectoryTree, MTBRootTree

public class MTBTree
extends Object
implements Cloneable

This class implements a simple tree data structure.

The main component of a tree is its root node. It can have an unrestricted number of children. The tree structure is implicitly given by the recursive (one-way) linkage of nodes to their children. Each node of the tree is associated with a certain data object. Each data object has to be derived from class 'TreeNodeData' to enable one of the basic features of this tree - the recursive printing of data contained within the tree.

Author:

Birgit Möller

See Also:

MTBTreeNode, MTBTreeNodeData

Field Summary

Fields

Modifier and Type	Field and Description
protected MTBTreeNode	root Root node of the tree.

Constructor Summary

Constructors

Constructor and Description
MTBTree(MTBTreeNode rootNode) Constructor for the tree for a given root node.
MTBTree(MTBTreeNodeData rootObject) Constructor for the tree.

Method Summary

Modifier and Type	Method and Description
MTBTree	clone()
protected static void	cloneChild(MTBTreeNode np, MTBTreeNode c) Helper function to recursively clone child nodes in a deep fashion.
Vector<MTBTreeNode>	getAllNodesDepthFirst() Get all nodes in a depth-first sorting.
MTBTreeNode	getRoot() Access the root node.
void	printTree() Prints tree data.

Methods inherited from class java.lang.Object

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

Field Detail

root

protected MTBTreeNode root

Root node of the tree.

Constructor Detail

MTBTree

public MTBTree(MTBTreeNodeData rootObject)

Constructor for the tree.

An associated data object has to be provided in any case.

Parameters:

rootObject - Data object associated with the root node.

MTBTree

public MTBTree(MTBTreeNode rootNode)

Constructor for the tree for a given root node.

Parameters:

rootNode - the root node

Method Detail

clone

public MTBTree clone()

Overrides:

clone in class Object

cloneChild

protected static void cloneChild(MTBTreeNode np,
                                 MTBTreeNode c)

Helper function to recursively clone child nodes in a deep fashion.

Parameters:

np - Parent node to which the clone of the child should be added.

c - Current child node to be cloned.

getRoot

public MTBTreeNode getRoot()

Access the root node.

Returns:

Reference to the root node of the tree.

printTree

public void printTree()

Prints tree data.

Special feature of this tree: this function prints recursively the data contained inside the tree. Prerequisite for this is that the data objects of each node provide a method for printing their data in a reasonable way, i.e. implement the method printData() of the abstract class TreeNodeData.

getAllNodesDepthFirst

public Vector<MTBTreeNode> getAllNodesDepthFirst()

Get all nodes in a depth-first sorting.

Returns:

List of all nodes of the tree.