org.dstadler.commons.graphviz

Class DotUtils

java.lang.Object

org.dstadler.commons.graphviz.DotUtils

public class DotUtils
extends java.lang.Object

Simple utility methods to run the dot-tool from Graphviz on a file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOT_EXE

Constructor Summary

Constructors

Constructor and Description
DotUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkDot() Verify if dot can be started and print out the version to stdout.
static void	renderGraph(java.io.File dotfile, java.io.File resultfile) Call graphviz-dot to convert the .dot-file to a rendered graph.
static void	setDotExe(java.lang.String dotExe) Allows to define where the exe-file for dot can be found.
static void	writeFooter(java.io.Writer writer) Closes the graph-markup with the necessary closing statements.
static void	writeHeader(java.io.Writer writer, int dpi, java.lang.String rankdir, java.lang.String id, java.util.List<java.lang.String> attribLines) Write the header structure.
static void	writeln(java.io.Writer writer, java.lang.String string) Write out the string and a newline
static void	writeln(java.io.Writer writer, java.lang.String string, int indentLevel) Write out the string and a newline, appending a number of tabs to properly indent the resulting text-file.

Methods inherited from class java.lang.Object

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

Field Detail

DOT_EXE

public static java.lang.String DOT_EXE

Constructor Detail

DotUtils

public DotUtils()

Method Detail

writeln

public static void writeln(java.io.Writer writer,
                           java.lang.String string)
                    throws java.io.IOException

Write out the string and a newline

Parameters:

writer - The writer for the .dot-file

string - The text to write

Throws:

java.io.IOException - if writing to the Writer fails

writeln

public static void writeln(java.io.Writer writer,
                           java.lang.String string,
                           int indentLevel)
                    throws java.io.IOException

Write out the string and a newline, appending a number of tabs to properly indent the resulting text-file.

Parameters:

writer - The writer for the .dot-file

string - The text to write

indentLevel - How much to indent the line

Throws:

java.io.IOException - if writing to the Writer fails

writeHeader

public static void writeHeader(java.io.Writer writer,
                               int dpi,
                               java.lang.String rankdir,
                               java.lang.String id,
                               java.util.List<java.lang.String> attribLines)
                        throws java.io.IOException

Write the header structure.

Parameters:

writer - A writer where the header is written to.

dpi - The resulting resolution, can be 0 for using the default DPI-setting of dot

rankdir - The direction of the graph, can be null

id - The id of the graph, cannot be null, needs to start with a alphabetical character, can contain numbers, alphabetic characters and underscore only.

attribLines - Additional attributes, can be null

Throws:

java.io.IOException - if writing to the Writer fails

writeFooter

public static void writeFooter(java.io.Writer writer)
                        throws java.io.IOException

Closes the graph-markup with the necessary closing statements.

Parameters:

writer - A writer where the footer is written to.

Throws:

java.io.IOException - if writing to the Writer fails

renderGraph

public static void renderGraph(java.io.File dotfile,
                               java.io.File resultfile)
                        throws java.io.IOException

Call graphviz-dot to convert the .dot-file to a rendered graph. The file extension of the specified result file is being used as the filetype of the rendering.

Parameters:

dotfile - The dot File used for the graph generation

resultfile - The File to which should be written

Throws:

java.io.IOException - if writing the resulting graph fails or other I/O problems occur

checkDot

public static boolean checkDot()
                        throws java.io.IOException

Verify if dot can be started and print out the version to stdout.

Returns:

True if "dot -V" ran successfully, false otherwise

Throws:

java.io.IOException - If running dot fails.

setDotExe

public static void setDotExe(java.lang.String dotExe)

Allows to define where the exe-file for dot can be found.

Parameters:

dotExe - The full pathname of the dot-executable.