Package org.jungrapht.visualization.util

Class TreeUtils

java.lang.Object

org.jungrapht.visualization.util.TreeUtils

public class TreeUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
TreeUtils()

Method Summary

Modifier and Type	Method	Description
static <V,E> void	addSubTree(org.jgrapht.Graph<V,E> tree, org.jgrapht.Graph<V,E> subTree, V subTreeParent, E connectingEdge)	Connects subTree to tree by attaching it as a child of subTreeParent with edge connectingEdge.
static <V,E> org.jgrapht.Graph<V,E>	getSubTree(org.jgrapht.Graph<V,E> tree, V root)	Returns a copy of the subtree of tree which is rooted at root.
static <V,E> void	growSubTree(org.jgrapht.Graph<V,E> tree, org.jgrapht.Graph<V,E> subTree, V root)	Populates subtree with the subtree of tree which is rooted at root.
static <V> boolean	isForestShaped(org.jgrapht.Graph<V,?> graph)	A graph is "forest-shaped" if it is directed, acyclic, and each vertex has at most one predecessor.
static <V,E> void	removeTreeVertex(org.jgrapht.Graph<V,E> tree, V subRoot)	removes a vertex and all descendants from a tree
static <V> Set<V>	roots(org.jgrapht.Graph<V,?> graph)

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeUtils

public TreeUtils()

Method Detail

roots

public static <V> Set<V> roots(org.jgrapht.Graph<V,?> graph)

isForestShaped

public static <V> boolean isForestShaped(org.jgrapht.Graph<V,?> graph)

A graph is "forest-shaped" if it is directed, acyclic, and each vertex has at most one predecessor.

getSubTree

public static <V,E> org.jgrapht.Graph<V,E> getSubTree(org.jgrapht.Graph<V,E> tree,
                                                                  V root)

Returns a copy of the subtree of tree which is rooted at root.

Type Parameters:

V - the vertex type

E - the edge type

Parameters:

tree - the tree whose subtree is to be extracted

root - the root of the subtree to be extracted

growSubTree

public static <V,E> void growSubTree(org.jgrapht.Graph<V,E> tree,
                                           org.jgrapht.Graph<V,E> subTree,
                                           V root)

Populates subtree with the subtree of tree which is rooted at root.

Type Parameters:

V - the vertex type

E - the edge type

Parameters:

tree - the tree whose subtree is to be extracted

subTree - the tree instance which is to be populated with the subtree of tree

root - the root of the subtree to be extracted

addSubTree

public static <V,E> void addSubTree(org.jgrapht.Graph<V,E> tree,
                                          org.jgrapht.Graph<V,E> subTree,
                                          V subTreeParent,
                                          E connectingEdge)

Connects subTree to tree by attaching it as a child of subTreeParent with edge connectingEdge.

Type Parameters:

V - the vertex type

E - the edge type

Parameters:

tree - the tree to which subTree is to be added

subTree - the tree which is to be grafted on to tree

subTreeParent - the parent of the root of subTree in its new position in tree

connectingEdge - the edge used to connect subTreeParent to subtree's root

removeTreeVertex

public static <V,E> void removeTreeVertex(org.jgrapht.Graph<V,E> tree,
                                                V subRoot)

removes a vertex and all descendants from a tree

Type Parameters:

V - the vertex type

E - the edge type

Parameters:

tree - the tree to mutate

subRoot - the vertex to remove