org.conqat.lib.commons.graph

Class GraphDebuggingUtils

java.lang.Object

org.conqat.lib.commons.graph.GraphDebuggingUtils

public class GraphDebuggingUtils
extends java.lang.Object

Useful methods for debugging arbitrary graphs.

Constructor Summary

Constructors

Constructor and Description
GraphDebuggingUtils()

Method Summary

Modifier and Type	Method and Description
static <NodeT,X extends java.lang.Exception> java.lang.String	getDotString(NodeT root, IIdProvider<java.lang.Integer,NodeT> optionalIdProvider, IMeshWalker<NodeT,X>... walkers) Returns a string representation of the graph in Dot format suitable for rendering with Graphviz.
static <NodeT,X extends java.lang.Exception> java.lang.String	getShortString(NodeT root, IIdProvider<java.lang.Integer,NodeT> optionalIdProvider, IMeshWalker<NodeT,X>... walkers) Returns a human-readable string representation of the graph.
static <NodeT,X extends java.lang.Exception> java.lang.String	getString(NodeT root, IIdProvider<java.lang.Integer,NodeT> optionalIdProvider, IMeshWalker<NodeT,X>... walkers) Returns a string representation of the graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphDebuggingUtils

public GraphDebuggingUtils()

Method Detail

getString

@SafeVarargs
public static <NodeT,X extends java.lang.Exception> java.lang.String getString(NodeT root,
                                                                                            IIdProvider<java.lang.Integer,NodeT> optionalIdProvider,
                                                                                            IMeshWalker<NodeT,X>... walkers)
                                                                                     throws X extends java.lang.Exception

Returns a string representation of the graph. The individual nodes are represented using their toString() method. This is useful for debugging.

Parameters:

root - the root node of the graph to visualize.

optionalIdProvider - an optional IdProvider that provides integer IDs for all Nodes. If null, we will use an IdManager. The IDs are assumed to be stable (the same on each query of the same node).

walkers - the mesh walkers used to traverse the graph.

Throws:

X extends java.lang.Exception

getShortString

@SafeVarargs
public static <NodeT,X extends java.lang.Exception> java.lang.String getShortString(NodeT root,
                                                                                                 IIdProvider<java.lang.Integer,NodeT> optionalIdProvider,
                                                                                                 IMeshWalker<NodeT,X>... walkers)
                                                                                          throws X extends java.lang.Exception

Returns a human-readable string representation of the graph. The individual nodes are only represented as integers. This is useful for debugging.

Parameters:

root - the root node of the graph to visualize.

optionalIdProvider - an optional IdProvider that provides integer IDs for all Nodes. If null, we will use an IdManager. The IDs are assumed to be stable (the same on each query of the same node).

walkers - the mesh walkers used to traverse the graph.

Throws:

X extends java.lang.Exception

getDotString

@SafeVarargs
public static <NodeT,X extends java.lang.Exception> java.lang.String getDotString(NodeT root,
                                                                                               IIdProvider<java.lang.Integer,NodeT> optionalIdProvider,
                                                                                               IMeshWalker<NodeT,X>... walkers)
                                                                                        throws X extends java.lang.Exception

Returns a string representation of the graph in Dot format suitable for rendering with Graphviz.

Parameters:

root - the root node of the graph to visualize.

optionalIdProvider - an optional IdProvider that provides integer IDs for all Nodes. If null, we will use an IdManager. The IDs are assumed to be stable (the same on each query of the same node).

walkers - the mesh walkers used to traverse different classes of edges found in the graph.

Throws:

X extends java.lang.Exception

See Also:

The DOT Language