prajna.util

Class TreeGraph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

java.lang.Object

prajna.util.AbstractGraph<N,E>

prajna.util.DirectedGraph<N,E>

prajna.util.TreeGraph<N,E>

Type Parameters:

N - Node class of the Graph

E - Edge class of the graph

All Implemented Interfaces:

java.io.Serializable, Graph<N,E>

public class TreeGraph<N extends javax.swing.tree.DefaultMutableTreeNode,E>
extends DirectedGraph<N,E>

Utility class for graphs which contain Trees as nodes. It provides additional functions to ensure that all nodes of a tree are included when added to the graph, and controls determining which edges are valid.

Author:

Edward Swing

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeGraph.EdgePolicy Determines whether an edge is acceptible to add to a TreeGraph

Constructor Summary

Constructors

Constructor and Description
TreeGraph() Instantiates a new empty tree graph with an EdgePolicy of ANY.
TreeGraph(Graph<? extends N,? extends E> graph) Instantiates a new tree graph with data copied from the specified graph, and an edge policy of ANY
TreeGraph(TreeGraph.EdgePolicy policy) Instantiates a new tree graph with a specified edge policy
TreeGraph(TreeGraph.EdgePolicy policy, Graph<? extends N,? extends E> graph) Instantiates a new tree graph with data copied from the specified graph, and the specified edge policy

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(N node) Add a tree node to the graph.
boolean	addEdge(E edge, N orig, N dest) Add an edge to the graph.
TreeGraph<N,E>	getChildGraph(N parent) Gets the child graph.
TreeGraph.EdgePolicy	getEdgePolicy() Gets the edge policy.
boolean	remove(java.lang.Object obj) Remove the node from the graph.
java.lang.String	toString() Return a string representation of this graph

Methods inherited from class prajna.util.DirectedGraph

getEdge, getEdgeSegment, getEdgeSet, getNodeSet, getSegmentSet, isDirected

Methods inherited from class prajna.util.AbstractGraph

addAll, clear, contains, containsEdge, edgeIterator, equals, getNodeEdges, hashCode, isEmpty, iterator, order, removeEdge, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeGraph

public TreeGraph()

Instantiates a new empty tree graph with an EdgePolicy of ANY.

TreeGraph

public TreeGraph(TreeGraph.EdgePolicy policy)

Instantiates a new tree graph with a specified edge policy

Parameters:

policy - the edge policy

TreeGraph

public TreeGraph(TreeGraph.EdgePolicy policy,
         Graph<? extends N,? extends E> graph)

Instantiates a new tree graph with data copied from the specified graph, and the specified edge policy

Parameters:

policy - the edge policy

graph - the graph to copy data from

TreeGraph

public TreeGraph(Graph<? extends N,? extends E> graph)

Instantiates a new tree graph with data copied from the specified graph, and an edge policy of ANY

Parameters:

graph - the graph to copy data from

Method Detail

add

public boolean add(N node)

Add a tree node to the graph. This will add all nodes within the tree to the graph.

Specified by:

add in interface Graph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Overrides:

add in class DirectedGraph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Parameters:

node - the tree node to add.

Returns:

true if the graph is modified as a result of this operation

addEdge

public boolean addEdge(E edge,
              N orig,
              N dest)

Add an edge to the graph. This method checks if the edge matches the specified Edge Policy, preventing edges which do not match.

Specified by:

addEdge in interface Graph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Overrides:

addEdge in class DirectedGraph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Parameters:

edge - The edge

orig - the origin node

dest - the destination node

Returns:

true if this operation modified the underlying graph, false otherwise.

getChildGraph

public TreeGraph<N,E> getChildGraph(N parent)

Gets the child graph. This method creates a new TreeGraph containing only the nodes which descend from the parent, and any edges which connect those nodes.

Parameters:

parent - the parent

Returns:

the child graph

getEdgePolicy

public TreeGraph.EdgePolicy getEdgePolicy()

Gets the edge policy.

Returns:

the edge policy

remove

public boolean remove(java.lang.Object obj)

Remove the node from the graph. This will also remove any nodes which are children of the specified node.

Specified by:

remove in interface Graph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Overrides:

remove in class AbstractGraph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Parameters:

obj - the node to remove

Returns:

true if the graph is modified as a result of this operation, false otherwise.

toString

public java.lang.String toString()

Return a string representation of this graph

Overrides:

toString in class DirectedGraph<N extends javax.swing.tree.DefaultMutableTreeNode,E>

Returns:

a string representation of this graph