g2d.graph

Class Dot

java.lang.Object

g2d.graph.Dot

public class Dot
extends java.lang.Object

Encapsulating the interface to the dot graph drawing and layout program.

Since:

July 2005

Author:

Ben Funnell, Ian A. Mason, Linda (some performance improvements)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dot.DotFormat
static class	Dot.FileType
static class	Dot.Version

Field Summary

Fields

Modifier and Type	Field and Description
static Dot.DotFormat	DEFAULT_DOT_FORMAT
static boolean	dotDebug
static boolean	dotVerbose
static float	MCLIMIT
static int	NSLIMIT
static int	NSLIMIT1
static Dot.Version	VERSION

Constructor Summary

Constructors

Constructor and Description
Dot()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	askDot(Dot.DotFormat type, java.lang.String input)
static java.lang.String	chopQuotes(java.lang.String str)
static java.lang.String	colorToDotHSB(java.awt.Color c) Converts a Java Color instance into a dot comprehensible string.
static Dot.DotFormat	int2DotFormat(int ord)
static java.lang.String	makeDotInput(IOPGraph graph, java.util.Collection<IOPSubgraph> subgraphs, java.util.Collection<IOPNode> nodes, java.util.Map<java.lang.Integer,IOPEdge> edgeMap) Computes the dot description of a IOPGraph instance from its nodes and edges.
static boolean	queryDot(Dot.DotFormat type, java.io.File dotIn, java.io.File dotOut) The method to use to query the dot graph layout program.
static java.lang.String	requestDot(Dot.DotFormat type, java.lang.String input)
static java.awt.Color	rgba2Color(java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final Dot.Version VERSION

dotDebug

public static boolean dotDebug

dotVerbose

public static boolean dotVerbose

NSLIMIT

public static int NSLIMIT

NSLIMIT1

public static int NSLIMIT1

MCLIMIT

public static float MCLIMIT

DEFAULT_DOT_FORMAT

public static final Dot.DotFormat DEFAULT_DOT_FORMAT

Constructor Detail

Dot

public Dot()

Method Detail

int2DotFormat

public static Dot.DotFormat int2DotFormat(int ord)

colorToDotHSB

public static java.lang.String colorToDotHSB(java.awt.Color c)

Converts a Java Color instance into a dot comprehensible string.

Parameters:

c - the Java color instance to be converted (using WHITE if this is null)

Returns:

String describing the color that dot will understand

rgba2Color

public static java.awt.Color rgba2Color(java.lang.String text)

makeDotInput

public static java.lang.String makeDotInput(IOPGraph graph,
                                            java.util.Collection<IOPSubgraph> subgraphs,
                                            java.util.Collection<IOPNode> nodes,
                                            java.util.Map<java.lang.Integer,IOPEdge> edgeMap)

Computes the dot description of a IOPGraph instance from its nodes and edges.

Parameters:

graph - the IOPGraph

subgraphs - Collection of IOPSubgraphs of the graph.

nodes - Collection of IOPNodes of the graph.

edgeMap - a map enumerating the IOPEdges of the graph.

Returns:

a string comprehensible to dot for formating, or creating images of.

queryDot

public static boolean queryDot(Dot.DotFormat type,
                               java.io.File dotIn,
                               java.io.File dotOut)

The method to use to query the dot graph layout program.

Parameters:

type - one of the integer codes indicating the desired format.

dotIn - the file to process.

dotOut - the output file.

Returns:

a boolean indicating success or failure.

See Also:

makeDotInput(g2d.graph.IOPGraph, java.util.Collection<g2d.graph.IOPSubgraph>, java.util.Collection<g2d.graph.IOPNode>, java.util.Map<java.lang.Integer, g2d.graph.IOPEdge>)

requestDot

public static java.lang.String requestDot(Dot.DotFormat type,
                                          java.lang.String input)

askDot

public static java.lang.String askDot(Dot.DotFormat type,
                                      java.lang.String input)

chopQuotes

public static java.lang.String chopQuotes(java.lang.String str)