diva.graphx

Class GraphUtilities

java.lang.Object

diva.graphx.GraphUtilities

public final class GraphUtilities
extends Object

A set of utilities for traversing/manipulating/etc. graphs.

Version:

$Revision: 1.1 $

Author:

Michael Shilman (michaels@eecs.berkeley.edu)

Method Summary

Modifier and Type	Method and Description
static boolean	checkConsistency(Object composite, GraphModel model) Check to make sure that all nodes and edges are self-consistent within a graph.
static boolean	checkContainment(Object composite, GraphModel model) Check to make sure that all nodes and edges are contained with in a graph and are consistent.
static Set	edgeSet(Object composite, GraphModel model) Return a new set that contains any edges that are connected to any nodes in the given composite.
static Iterator	inNodes(Object node, GraphModel model) Return an iterator over the nodes on the other side of edges arriving in the given node.
static boolean	isContainedNode(Object node, Object composite, GraphModel model)
static boolean	isPartiallyContainedEdge(Object edge, Object composite, GraphModel model)
static boolean	isTotallyContainedEdge(Object edge, Object composite, GraphModel model)
static Iterator	localEdges(Object composite, GraphModel model) Deprecated. use totallyContainedEdges instead.
static Set	nodeSet(Object composite, GraphModel model) Return a new set that contains all the nodes that are deeply contained in the given composite.
static Iterator	outNodes(Object node, GraphModel model) Return an iterator over the nodes on the other side of edges emanating from the given node.
static Iterator	partiallyContainedEdges(Object composite, GraphModel model) Return an iterator over the edges in a graph which are partially contained within the given composite node.
static void	purgeNode(Object eventSource, Object node, GraphModel model) Disconnect all of the edges connected to the given node, then remove it from its graph.
static Iterator	totallyContainedEdges(Object composite, GraphModel model) Return an iterator over the edges in a graph which are totally contained within the given composite node.

Methods inherited from class java.lang.Object

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

Method Detail

checkConsistency

public static final boolean checkConsistency(Object composite,
                                             GraphModel model)

Check to make sure that all nodes and edges are self-consistent within a graph.

checkContainment

public static final boolean checkContainment(Object composite,
                                             GraphModel model)

Check to make sure that all nodes and edges are contained with in a graph and are consistent.

edgeSet

public static final Set edgeSet(Object composite,
                                GraphModel model)

Return a new set that contains any edges that are connected to any nodes in the given composite.

isContainedNode

public static boolean isContainedNode(Object node,
                                      Object composite,
                                      GraphModel model)

isPartiallyContainedEdge

public static boolean isPartiallyContainedEdge(Object edge,
                                               Object composite,
                                               GraphModel model)

isTotallyContainedEdge

public static boolean isTotallyContainedEdge(Object edge,
                                             Object composite,
                                             GraphModel model)

inNodes

public static final Iterator inNodes(Object node,
                                     GraphModel model)

Return an iterator over the nodes on the other side of edges arriving in the given node.

nodeSet

public static final Set nodeSet(Object composite,
                                GraphModel model)

Return a new set that contains all the nodes that are deeply contained in the given composite.

outNodes

public static final Iterator outNodes(Object node,
                                      GraphModel model)

Return an iterator over the nodes on the other side of edges emanating from the given node.

purgeNode

public static final void purgeNode(Object eventSource,
                                   Object node,
                                   GraphModel model)
                            throws GraphException

Disconnect all of the edges connected to the given node, then remove it from its graph.

Throws:

GraphException - if the operation fails.

partiallyContainedEdges

public static final Iterator partiallyContainedEdges(Object composite,
                                                     GraphModel model)

Return an iterator over the edges in a graph which are partially contained within the given composite node. (i.e. the edges whose head node, or tail node is in the composite, or a subnode).

totallyContainedEdges

public static final Iterator totallyContainedEdges(Object composite,
                                                   GraphModel model)

Return an iterator over the edges in a graph which are totally contained within the given composite node. (i.e. the edges whose head and tail nodes are both in the composite, or a subnode).

localEdges

public static final Iterator localEdges(Object composite,
                                        GraphModel model)

Deprecated. use totallyContainedEdges instead.

Return an iterator over the edges in a graph which are local to that graph (i.e. the edges whose head and tail nodes are both in the graph, or a subgraph)