net.automatalib.graphs.dot

Interface GraphDOTHelper<N,E>

Type Parameters:

N - node class

E - edge class

All Known Implementing Classes:

AggregateDOTHelper, DefaultDOTHelper, DefaultDOTHelperAutomaton, DelegateDOTHelper, DFSExample.DFSResultDOTHelper, DOTHelperFSA, DOTHelperMealy, EmptyDOTHelper

public interface GraphDOTHelper<N,E>

Helper interface for plotting graphs using the GraphVIZ DOT format.

Author:

Malte Isberner

Field Summary

Fields

Modifier and Type	Field and Description
static String	LABEL
static String	SHAPE

Method Summary

Modifier and Type	Method and Description
boolean	getEdgeProperties(N src, E edge, N tgt, Map<String,String> properties) Retrieves the GraphVIZ properties for rendering a single edge.
boolean	getNodeProperties(N node, Map<String,String> properties) Retrieves the GraphVIZ properties for rendering a single node.
void	writePostamble(Mapping<N,String> identifiers, Appendable a) Called after the node and edge data are written, but before the closing brace.
void	writePreamble(Appendable a) Called before the node and edge data are written, but after the opening "digraph {" statement.

Field Detail

LABEL

static final String LABEL

See Also:

Constant Field Values

SHAPE

static final String SHAPE

See Also:

Constant Field Values

Method Detail

writePreamble

void writePreamble(Appendable a)
            throws IOException

Called before the node and edge data are written, but after the opening "digraph {" statement.

Parameters:

a - the Appendable to write to

Throws:

IOException - if writing to a throws.

writePostamble

void writePostamble(Mapping<N,String> identifiers,
                    Appendable a)
             throws IOException

Called after the node and edge data are written, but before the closing brace.

Parameters:

a - the Appendable to write to

Throws:

IOException - if writing to a throws.

getNodeProperties

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

Retrieves the GraphVIZ properties for rendering a single node. Additionally, the return value allows to control whether or not 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 or not this node should be rendered

getEdgeProperties

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

Retrieves the GraphVIZ properties for rendering a single edge. Additionally, the return value allows to control whether or not 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 or not this edge should be rendered