visualizations

Class StdVisualizer

java.lang.Object

visualizations.StdVisualizer

All Implemented Interfaces:

GraphVisualizer

public class StdVisualizer
extends java.lang.Object
implements GraphVisualizer

The standard graph visualizer of Graphana. Uses the default java JFrame and Graphics to draw vertices. Layouts are bound externally and appearance of vertices and edges can be modified per vertex or edge depending on vertex or edge data and status.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	GUI_ADDED

Constructor Summary

Constructors

Constructor and Description
StdVisualizer(StdGraphLayouts layouts) Creates an instance

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.String>	getLayoutKeys() Enables iterating over all layout keys of the visualizer.
StdGraphLayouts	getLayouts() Returns all supported layouts
java.lang.String	getVisualizerKey() Returns the (unique) key of the visualizer.
<VertexType,EdgeType> java.awt.Component	visualizeGraph(GraphLibrary<VertexType,EdgeType> graph, java.lang.String layoutKeyParams, int initialWidth, int initialHeight, boolean enableManualUpdate, boolean enableModification) Visualizes the given graph.

Methods inherited from class java.lang.Object

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

Field Detail

GUI_ADDED

public static final java.lang.Object GUI_ADDED

Constructor Detail

StdVisualizer

public StdVisualizer(StdGraphLayouts layouts)

Creates an instance

Parameters:

layouts - the collection of layouts. This class never modifies this list, it can therefore be used and updated in other classes

Method Detail

visualizeGraph

public <VertexType,EdgeType> java.awt.Component visualizeGraph(GraphLibrary<VertexType,EdgeType> graph,
                                                               java.lang.String layoutKeyParams,
                                                               int initialWidth,
                                                               int initialHeight,
                                                               boolean enableManualUpdate,
                                                               boolean enableModification)
                                                        throws ArrangeException

Description copied from interface: GraphVisualizer

Visualizes the given graph.

Specified by:

visualizeGraph in interface GraphVisualizer

Type Parameters:

VertexType - the type of the vertices of the graph.

EdgeType - the type of the edges of the graph.

Parameters:

graph - the graph to be visualized.

layoutKeyParams - one string containing the arguments to manipulate the layout.

initialWidth - the initial width of the output area.

initialHeight - the initial height of the output area.

enableManualUpdate - if true, then refreshing of the visualization must be done explicitly. Otherwise, the visualizer will periodically refresh or refresh automatically whenever it is necessary.

enableModification - if true, then the user can modify the graph instance foor example by inserting and deleting vertices.

Returns:

the component containing the visual graph output.

Throws:

ArrangeException - if the vertices can not be arranged.

getVisualizerKey

public java.lang.String getVisualizerKey()

Description copied from interface: GraphVisualizer

Returns the (unique) key of the visualizer.

Specified by:

getVisualizerKey in interface GraphVisualizer

Returns:

the key of the visualizer.

getLayouts

public StdGraphLayouts getLayouts()

Returns all supported layouts

getLayoutKeys

public java.lang.Iterable<java.lang.String> getLayoutKeys()

Description copied from interface: GraphVisualizer

Enables iterating over all layout keys of the visualizer.

Specified by:

getLayoutKeys in interface GraphVisualizer

Returns:

Iterable for all layout keys.