examples.util

Class GraphViewer

java.lang.Object

examples.util.GraphViewer

public class GraphViewer
extends java.lang.Object

Utility methods to render and display explanation graphs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphViewer.BitmapJFrame Receives a byte array as an input, and shows it in a Swing window as a picture.

Constructor Summary

Constructors

Constructor and Description
GraphViewer()

Method Summary

Modifier and Type	Method and Description
static void	display(java.util.List<Node> roots) Displays an explanation graph into a window.
static void	display(java.util.List<Node> roots, boolean no_captions) Displays an explanation graph into a window.
static void	display(Node root) Displays an explanation graph into a window.
protected static byte[]	getGraph(java.util.List<Node> roots, boolean no_captions) Renders a graph, calls DOT in the background and retrieves the binary image it produces.
static void	save(java.util.List<Node> roots, java.lang.String filename) Saves a graph to a file.
static void	save(java.util.List<Node> roots, java.lang.String filename, boolean no_captions) Saves a graph to a file.
static void	save(Node root, java.lang.String filename, boolean no_captions) Saves a graph to a file.
static java.lang.String	toDot(java.util.List<Node> roots, boolean no_captions) Renders a graph as a DOT file.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphViewer

public GraphViewer()

Method Detail

display

public static void display(java.util.List<Node> roots,
                           boolean no_captions)

Displays an explanation graph into a window. This method acts as a primitive image viewer, used to display the result of the examples.

Parameters:

roots - The roots of the graph to display

no_captions - Set to true to hide non-leaf captions

display

public static void display(java.util.List<Node> roots)

Displays an explanation graph into a window. This method acts as a primitive image viewer, used to display the result of the examples.

Parameters:

roots - The roots of the graph to display

display

public static void display(Node root)

Displays an explanation graph into a window. This method acts as a primitive image viewer, used to display the result of the examples.

Parameters:

root - The root of the graph to display

save

public static void save(java.util.List<Node> roots,
                        java.lang.String filename,
                        boolean no_captions)

Saves a graph to a file.

Parameters:

roots - The roots of the graph to display

filename - The file where this graph will be saved

no_captions - Set to true to hide non-leaf captions

save

public static void save(Node root,
                        java.lang.String filename,
                        boolean no_captions)

Saves a graph to a file.

Parameters:

root - The root of the graph to display

filename - The file where this graph will be saved

no_captions - Set to true to hide non-leaf captions

save

public static void save(java.util.List<Node> roots,
                        java.lang.String filename)

Saves a graph to a file.

Parameters:

roots - The roots of the graph to display

filename - The file where this graph will be saved

toDot

public static java.lang.String toDot(java.util.List<Node> roots,
                                     boolean no_captions)

Renders a graph as a DOT file.

Parameters:

roots - The roots of the graph to render

no_captions - Set to true to hide non-leaf captions

Returns:

A string with the contents of the DOT file

getGraph

protected static byte[] getGraph(java.util.List<Node> roots,
                                 boolean no_captions)

Renders a graph, calls DOT in the background and retrieves the binary image it produces.

Parameters:

roots - The roots of the graph to render

no_captions - Set to true to hide non-leaf captions

Returns:

An array of bytes containing the image to display