com.phoenixst.plexus

Interface RootedTree

All Superinterfaces:

OrientedForest, Rooted

All Known Implementing Classes:

DefaultRootedTreeView, DepthFirstTreeView, ForestTreeAdapter, ForestTreeExtension

public interface RootedTree
extends OrientedForest, Rooted

An OrientedForest which is restricted to the descendants of a single root node.

The following methods behave as expected:

• getRoot()
• setRoot( root )
• isForestEdge( edge )
• getParentEndpoint( edge )

The getRoot( node ) method will throw a NoSuchNodeException if given a node which is not a descendant of the root node.

The following methods may throw a NoSuchNodeException if given a node which is not a descendant of the root node, depending upon whether or not it is computationally tenable to do so. The behavior of any concrete implementations of these methods should be explicitly documented.

• getParent( node )
• childTraverser( node )
• getParentEdge( node )
• isLeaf( node )
• isAncestor( ancestor, descendant )
• getLeastCommonAncestor( aNode, bNode )
• getDepth( node )
• getHeight( node )

Since:

1.0

Version:

$Revision: 1.3 $

Author:

Ray A. Conner

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTreeNode(Object node) Returns true if the specified node is a descendant of the root node.

Methods inherited from interface com.phoenixst.plexus.OrientedForest

childTraverser, getDepth, getHeight, getLeastCommonAncestor, getParent, getParentEdge, getParentEndpoint, getRoot, isAncestor, isForestEdge, isLeaf, rootNodes

Methods inherited from interface com.phoenixst.plexus.Rooted

getRoot, setRoot

Method Detail

isTreeNode

boolean isTreeNode(Object node)

Returns true if the specified node is a descendant of the root node.