Package net.automatalib.visualization

Interface VisualizationHelper<N,E>

Type Parameters:

N - node class

E - edge class

All Known Implementing Classes:

AutomatonVisualizationHelper, CFMPSVisualizationHelper, DefaultVisualizationHelper, FSAVisualizationHelper, MealyVisualizationHelper, MooreVisualizationHelper, MTSVisualizationHelper, PMPGVisualizationHelper, ProceduralVisualizationHelper, SSTVisualizationHelper

public interface VisualizationHelper<N,E>

Helper interface for providing additional styling properties for plotting graphs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	VisualizationHelper.CommonAttrs
static class	VisualizationHelper.CommonStyles
static class	VisualizationHelper.EdgeAttrs
static class	VisualizationHelper.EdgeStyles
static class	VisualizationHelper.MTSEdgeAttrs
static class	VisualizationHelper.NodeAttrs
static class	VisualizationHelper.NodeShapes
static class	VisualizationHelper.NodeStyles

Method Summary

Modifier and Type	Method	Description
boolean	getEdgeProperties(N src, E edge, N tgt, Map<String,String> properties)	Retrieves the properties for rendering a single edge.
default void	getGlobalEdgeProperties(Map<String,String> properties)
default void	getGlobalNodeProperties(Map<String,String> properties)
boolean	getNodeProperties(N node, Map<String,String> properties)	Retrieves the properties for rendering a single node.

Method Detail

getGlobalNodeProperties

default void getGlobalNodeProperties(Map<String,String> properties)

getGlobalEdgeProperties

default void getGlobalEdgeProperties(Map<String,String> properties)

getNodeProperties

boolean getNodeProperties(N node,
                          Map<String,String> properties)

Retrieves the properties for rendering a single node. Additionally, the return value allows to control whether to omit this node from rendering. If false is returned, the node will not be rendered. Consequently, any modifications to the properties map will have no effect.

The properties are stored in the Map argument. Note that if an implementation of a base class is overridden, it is probably a good idea to call super.getNodeProperties(node, properties); at the beginning of the method.

Parameters:

node - the node to be rendered

properties - the property map

Returns:

whether this node should be rendered

getEdgeProperties

boolean getEdgeProperties(N src,
                          E edge,
                          N tgt,
                          Map<String,String> properties)

Retrieves the properties for rendering a single edge. Additionally, the return value allows to control whether to omit this edge from rendering. If false is returned, the edge will not be rendered. Consequently, any modifications to the properties map will have no effect.

The properties are stored in the Map argument. Note that if an implementation of a base class is overridden, it is probably a good idea to call super.getEdgeProperties(node, properties); at the beginning of the method.

Parameters:

edge - the edge to be rendered

properties - the property map

Returns:

whether this edge should be rendered