salvo.jesus.graph

Class TreeImpl

java.lang.Object

salvo.jesus.graph.GraphImpl

salvo.jesus.graph.TreeImpl

All Implemented Interfaces:

Serializable, Graph, Tree

public class TreeImpl
extends GraphImpl
implements Tree

An implementation of a Tree. This implementation is a free tree and allows zero, one or more child nodes for each node. A free tree is a tree whereby any of the nodes can be a root node. By defauly, the first node added when the tree is empty is the root node.

Directions of Edges in tree are generally ignored. Directionality is basically implied when specifying the root of a Tree, where such operation requires it.

A Tree does not allow cycle paths. So any attempts to create a cycle will thrown a CycleException.

Author:

Jesus M. Salvo Jr.

See Also:

Serialized Form

Field Summary

Fields inherited from class salvo.jesus.graph.GraphImpl

factory, traversal

Constructor Summary

Constructors

Constructor and Description
TreeImpl() Creates an instance of a TreeImpl

Method Summary

Modifier and Type	Method and Description
Edge	addNode(Vertex parent, Vertex childNode) Convenience method to adding nodes in a Tree.
Tree	createTree() Factory method that returns a new instance of TreeImpl.
List	getChildren(Vertex vertex) Returns the child nodes of the node specified by the argument.
int	getDepth(Vertex node) Returns the depth of the node in the Tree.
int	getHeight() Returns the height of the Tree.
List	getLeaves() Returns a List of the leaves of ths Tree.
Vertex	getParent(Vertex vertex) Returns the parent node of the node specified by the argument.
Vertex	getRoot() Returns the current root of the Tree.
Tree	getSubTree(Vertex subTreeRootVertex) Returns a new instance of a Tree that is rooted from the specified node.
boolean	isLeaf(Vertex vertex) Returns true if the specified node is a leaf.
void	setRoot(Vertex rootVertex) Sets the root of the Tree.

Methods inherited from class salvo.jesus.graph.GraphImpl

add, addEdge, addEdge, addGraphAddEdgeListener, addGraphAddVertexListener, addGraphRemoveEdgeListener, addGraphRemoveVertexListener, addListener, cloneVertices, containsEdge, containsVertex, forgetConnectedSets, getAdjacentVertices, getAdjacentVertices, getConnectedSet, getConnectedSet, getDegree, getDegree, getEdges, getEdgesCount, getEdgeSet, getGraphFactory, getTraversal, getVertexSet, getVertices, getVerticesCount, getVerticesIterator, isConnected, remove, removeEdge, removeEdges, removeGraphAddEdgeListener, removeGraphAddVertexListener, removeGraphRemoveEdgeListener, removeGraphRemoveVertexListener, removeListener, setGraphFactory, setTraversal, toString, traverse

Methods inherited from class java.lang.Object

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

Methods inherited from interface salvo.jesus.graph.Graph

add, addEdge, addEdge, addGraphAddEdgeListener, addGraphAddVertexListener, addGraphRemoveEdgeListener, addGraphRemoveVertexListener, addListener, cloneVertices, getAdjacentVertices, getAdjacentVertices, getConnectedSet, getConnectedSet, getDegree, getDegree, getEdges, getEdgesCount, getEdgeSet, getGraphFactory, getTraversal, getVertexSet, getVertices, getVerticesCount, getVerticesIterator, isConnected, remove, removeEdge, removeEdges, removeGraphAddEdgeListener, removeGraphAddVertexListener, removeGraphRemoveEdgeListener, removeGraphRemoveVertexListener, removeListener, setGraphFactory, setTraversal, traverse

Constructor Detail

TreeImpl

public TreeImpl()

Creates an instance of a TreeImpl

Method Detail

setRoot

public void setRoot(Vertex rootVertex)
             throws GraphException

Description copied from interface: Tree

Sets the root of the Tree. The Vertex specified must already be in the Tree. Otherwise, a NoSuchVertexException is returned.

Specified by:

setRoot in interface Tree

Throws:

GraphException

See Also:

Tree.setRoot(salvo.jesus.graph.Vertex)

getRoot

public Vertex getRoot()

Description copied from interface: Tree

Returns the current root of the Tree. It is possible that this method will return null if the Tree is empty.

Specified by:

getRoot in interface Tree

See Also:

Tree.getRoot()

isLeaf

public boolean isLeaf(Vertex vertex)
               throws GraphException

Description copied from interface: Tree

Returns true if the specified node is a leaf.

Specified by:

isLeaf in interface Tree

Throws:

EmptyTreeException - is the Tree is empty.

GraphException

See Also:

Tree.isLeaf(salvo.jesus.graph.Vertex)

getParent

public Vertex getParent(Vertex vertex)
                 throws GraphException

Description copied from interface: Tree

Returns the parent node of the node specified by the argument.

Specified by:

getParent in interface Tree

Throws:

EmptyTreeException - is the Tree is empty.

GraphException

See Also:

Tree.getParent(salvo.jesus.graph.Vertex)

getChildren

public List getChildren(Vertex vertex)
                 throws GraphException

Description copied from interface: Tree

Returns the child nodes of the node specified by the argument.

Specified by:

getChildren in interface Tree

Throws:

EmptyTreeException - is the Tree is empty.

GraphException

See Also:

Tree.getChildren(salvo.jesus.graph.Vertex)

getSubTree

public Tree getSubTree(Vertex subTreeRootVertex)
                throws Exception

Description copied from interface: Tree

Returns a new instance of a Tree that is rooted from the specified node. This method does not alter the Tree itself.

Although a new Tree is returned, the nodes and edges within the new Tree are the same instances as those of the Tree from where it was taken from.

Specified by:

getSubTree in interface Tree

Parameters:

subTreeRootVertex - The root of the subtree that we want to return

Throws:

EmptyTreeException - is the Tree is empty.

Exception

See Also:

Tree.getSubTree(salvo.jesus.graph.Vertex)

getDepth

public int getDepth(Vertex node)
             throws GraphException

Description copied from interface: Tree

Returns the depth of the node in the Tree.

Specified by:

getDepth in interface Tree

Throws:

GraphException

See Also:

Tree.getDepth(salvo.jesus.graph.Vertex)

getLeaves

public List getLeaves()

Description copied from interface: Tree

Returns a List of the leaves of ths Tree.

Specified by:

getLeaves in interface Tree

See Also:

Tree.getLeaves()

getHeight

public int getHeight()

Description copied from interface: Tree

Returns the height of the Tree.

Specified by:

getHeight in interface Tree

See Also:

Tree.getHeight()

createTree

public Tree createTree()

Factory method that returns a new instance of TreeImpl.

Specified by:

createTree in interface Tree

addNode

public Edge addNode(Vertex parent,
                    Vertex childNode)
             throws Exception

Description copied from interface: Tree

Convenience method to adding nodes in a Tree.

Adds a node to the Tree. The parent node must already be existing in the Tree before the child node can be added. To add the root node, specify null as the parent.

Note that the parent and child relativity is dependent for whatever is the current root node of the Tree. Hence, if childNode later on becomes root via setRoot(), then the parent actually becomes the child of childNode.

Specified by:

addNode in interface Tree

Throws:

GraphException - if there is already a root or the child node is already existing.

NoSuchVertexException - if the parent is not null and is not existing

Exception

See Also:

Tree.addNode(salvo.jesus.graph.Vertex, salvo.jesus.graph.Vertex)