net.automatalib.visualization

Interface VisualizationProvider

All Known Implementing Classes:

DummyVP, GraphVizBrowserVisualizationProvider, GraphVizSwingVisualizationProvider, JungGraphVisualizationProvider

public interface VisualizationProvider

Author:

Malte Isberner

Method Summary

Modifier and Type	Method and Description
boolean	checkUsable() Checks whether the provider is supported on the current platform.
default String	getDescription() Returns a description of the provider.
String	getId() Returns the id of the visualization provider.
default int	getPriority() Returns the priority of the provider.
<N,E> void	visualize(Graph<N,E> graph, List<VisualizationHelper<N,? super E>> additionalHelpers, boolean modal, Map<String,String> visOptions) Visualizes the given graph by means of executing the visualization implementation.

Method Detail

getId

String getId()

Returns the id of the visualization provider. This value is used and matched against the AutomataLibProperty.VISUALIZATION_PROVIDER property to select the chosen visualization provider.

Returns:

the id of the provider

getDescription

default String getDescription()

Returns a description of the provider.

Returns:

the description of the provider

getPriority

default int getPriority()

Returns the priority of the provider. If no provider is selected via the AutomataLibProperty.VISUALIZATION_PROVIDER property, the provider with the highest priority is chosen.

Returns:

the priority of the provider

checkUsable

boolean checkUsable()

Checks whether the provider is supported on the current platform.

Returns:

true if the provider is able to visualiza, false otherwise

See Also:

visualize(Graph, List, boolean, Map)

visualize

<N,E> void visualize(Graph<N,E> graph,
                     List<VisualizationHelper<N,? super E>> additionalHelpers,
                     boolean modal,
                     Map<String,String> visOptions)

Visualizes the given graph by means of executing the visualization implementation.

Type Parameters:

N - the node type of the graph model

E - the edge type of the graph model

Parameters:

graph - the graph model to visualize

additionalHelpers - additional helpers to influence the visualization

modal - a flag, whether the visualized graph should be displayed in a modal dialog (halting the current program execution) or not.

visOptions - additional options for the provider