com.phoenixst.plexus
Class ForestTreeExtension

java.lang.Object
  com.phoenixst.plexus.ForestTreeExtension

All Implemented Interfaces:

OrientedForest, Rooted, RootedTree

public class ForestTreeExtension
extends Object
implements RootedTree

A RootedTree which is formed by extending an OrientedForest, adding a dummy root node (and edges) which is the parent of the forest's root nodes.

Since:

1.0

Version:

$Revision: 1.9 $

Author:

Ray A. Conner

Constructor Summary

ForestTreeExtension(Object root, OrientedForest forest)
Creates a new ForestTreeExtension.

ForestTreeExtension(OrientedForest forest)
Creates a new ForestTreeExtension.

Method Summary

Traverser	childTraverser(Object node) Returns a Traverser over the children of the specified node.
int	getDepth(Object node) Gets the depth of the specified node.
int	getHeight(Object node) Gets the height of the specified node.
Object	getLeastCommonAncestor(Object aNode, Object bNode) Returns the least common ancestor of the specified nodes, or null if none exists.
Object	getParent(Object node) Gets the parent of the specified node, or null if it doesn't have one.
Graph.Edge	getParentEdge(Object node) Gets the parent Edge of the specified node, or null if it doesn't have one.
Object	getParentEndpoint(Graph.Edge edge) Returns the parent endpoint of the specified forest Edge.
Object	getRoot() Gets the root node.
Object	getRoot(Object node) Gets the root of the subgraph containing the specified node.
boolean	isAncestor(Object ancestor, Object descendant) Returns true if ancestor is actually an ancestor of descendant.
boolean	isForestEdge(Graph.Edge edge) Gets whether or not the specified Edge is a forest edge.
boolean	isLeaf(Object node) Returns true if the specified node has no children.
boolean	isTreeNode(Object node) If the specified node is not the root node, this method delegates to OrientedForest.getParent(java.lang.Object) and returns true if a NoSuchNodeException is not thrown.
Collection	rootNodes() Returns the root nodes of this forest.
void	setRoot(Object root) Sets the root node, which must not be contained by the forest being extended, although this implementation does not check for that condition.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForestTreeExtension

public ForestTreeExtension(OrientedForest forest)

Creates a new ForestTreeExtension.

ForestTreeExtension

public ForestTreeExtension(Object root,
                           OrientedForest forest)

Creates a new ForestTreeExtension. The specified forest should not contain the given root node.

Method Detail

getRoot

public Object getRoot()

Description copied from interface: Rooted

Gets the root node.

Specified by:

getRoot in interface Rooted

setRoot

public void setRoot(Object root)

Sets the root node, which must not be contained by the forest being extended, although this implementation does not check for that condition.

Specified by:

setRoot in interface Rooted

getParent

public Object getParent(Object node)

Description copied from interface: OrientedForest

Gets the parent of the specified node, or null if it doesn't have one. If null is a valid node, then OrientedForest.getParentEdge(java.lang.Object) must be used to distinguish the two cases.

Specified by:

getParent in interface OrientedForest

childTraverser

public Traverser childTraverser(Object node)

Returns a Traverser over the children of the specified node. Traversers over the children of the root node are unmodifiable.

Specified by:

childTraverser in interface OrientedForest

getParentEdge

public Graph.Edge getParentEdge(Object node)

Description copied from interface: OrientedForest

Gets the parent Edge of the specified node, or null if it doesn't have one.

Specified by:

getParentEdge in interface OrientedForest

isForestEdge

public boolean isForestEdge(Graph.Edge edge)

Description copied from interface: OrientedForest

Gets whether or not the specified Edge is a forest edge.

Specified by:

isForestEdge in interface OrientedForest

getParentEndpoint

public Object getParentEndpoint(Graph.Edge edge)

Description copied from interface: OrientedForest

Returns the parent endpoint of the specified forest Edge. If the specified Edge is not a forest edge, throws an IllegalArgumentException.

Specified by:

getParentEndpoint in interface OrientedForest

rootNodes

public Collection rootNodes()

Description copied from interface: OrientedForest

Returns the root nodes of this forest.

Specified by:

rootNodes in interface OrientedForest

getRoot

public Object getRoot(Object node)

Description copied from interface: OrientedForest

Gets the root of the subgraph containing the specified node.

Specified by:

getRoot in interface OrientedForest

isLeaf

public boolean isLeaf(Object node)

Description copied from interface: OrientedForest

Returns true if the specified node has no children.

Specified by:

isLeaf in interface OrientedForest

isAncestor

public boolean isAncestor(Object ancestor,
                          Object descendant)

Description copied from interface: OrientedForest

Returns true if ancestor is actually an ancestor of descendant.

Specified by:

isAncestor in interface OrientedForest

getLeastCommonAncestor

public Object getLeastCommonAncestor(Object aNode,
                                     Object bNode)

Description copied from interface: OrientedForest

Returns the least common ancestor of the specified nodes, or null if none exists. If null is a valid node, then some other method must be used to distinguish the two cases.

Specified by:

getLeastCommonAncestor in interface OrientedForest

getDepth

public int getDepth(Object node)

Description copied from interface: OrientedForest

Gets the depth of the specified node.

Specified by:

getDepth in interface OrientedForest

getHeight

public int getHeight(Object node)

Description copied from interface: OrientedForest

Gets the height of the specified node.

Specified by:

getHeight in interface OrientedForest

isTreeNode

public boolean isTreeNode(Object node)

If the specified node is not the root node, this method delegates to OrientedForest.getParent(java.lang.Object) and returns true if a NoSuchNodeException is not thrown. Otherwise, it returns false.

Specified by:

isTreeNode in interface RootedTree