salvo.jesus.graph

Interface Tree

All Superinterfaces:

Graph, Serializable

All Known Subinterfaces:

BinaryTree

All Known Implementing Classes:

TreeImpl

public interface Tree
extends Graph

The superinterface of all Trees. This interface abstracts a free tree. A free tree is a tree whereby any of the nodes can be a root node.

Author:

Jesus M. Salvo Jr.

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 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

Method Detail

setRoot

void setRoot(Vertex rootVertex)
      throws GraphException

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

Throws:

GraphException

getRoot

Vertex getRoot()

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

getParent

Vertex getParent(Vertex vertex)
          throws GraphException

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

Throws:

EmptyTreeException - is the Tree is empty.

GraphException

getChildren

List getChildren(Vertex vertex)
          throws GraphException

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

Throws:

EmptyTreeException - is the Tree is empty.

GraphException

getSubTree

Tree getSubTree(Vertex subTreeRootVertex)
         throws Exception

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.

Parameters:

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

Throws:

EmptyTreeException - is the Tree is empty.

Exception

getDepth

int getDepth(Vertex node)
      throws GraphException

Returns the depth of the node in the Tree.

Throws:

GraphException

getLeaves

List getLeaves()

Returns a List of the leaves of ths Tree.

getHeight

int getHeight()

Returns the height of the Tree.

addNode

Edge addNode(Vertex parent,
             Vertex childNode)
      throws Exception

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.

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

isLeaf

boolean isLeaf(Vertex vertex)
        throws GraphException

Returns true if the specified node is a leaf.

Throws:

EmptyTreeException - is the Tree is empty.

GraphException

createTree

Tree createTree()

Factory method that returns a new instance of TreeImpl.