nl.nn.adapterframework.util.flow.graphviz

Class GraphvizEngine

java.lang.Object

nl.nn.adapterframework.util.flow.graphviz.GraphvizEngine

public class GraphvizEngine
extends Object

JavaScript engine wrapper for VizJs flow diagrams

Author:

Niels Meijer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
GraphvizEngine() Create a new GraphvizEngine instance.
GraphvizEngine(String graphvizVersion) Create a new GraphvizEngine instance

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the GraphvizEngine instance
String	execute(String src) Execute GraphViz with default options (Format.SVG)
String	execute(String src, Options options) Execute GraphViz
protected void	finalize() The GraphvizJsFlowGenerator uses a ThreadLocal+SoftReference map to cache the GraphvisEngines.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

GraphvizEngine

public GraphvizEngine()
               throws IOException

Create a new GraphvizEngine instance. Using version 2.0.0

Throws:

IOException

GraphvizEngine

public GraphvizEngine(String graphvizVersion)
               throws IOException

Create a new GraphvizEngine instance

Parameters:

graphvizVersion - version of the the VisJs engine to initiate

Throws:

IOException

Method Detail

execute

public String execute(String src)
               throws IOException,
                      FlowGenerationException

Execute GraphViz with default options (Format.SVG)

Parameters:

src - dot file

Returns:

Format.SVG string

Throws:

IOException - when VizJs files can't be found on the classpath

FlowGenerationException - when a JavaScript engine error occurs

execute

public String execute(String src,
                      Options options)
               throws IOException,
                      FlowGenerationException

Execute GraphViz

Parameters:

src - dot file

options - see Options

Returns:

string in specified Format

Throws:

IOException - when VizJs files can't be found on the classpath

FlowGenerationException - when a JavaScript engine error occurs

close

public void close()

Shuts down the GraphvizEngine instance

finalize

protected void finalize()
                 throws Throwable

The GraphvizJsFlowGenerator uses a ThreadLocal+SoftReference map to cache the GraphvisEngines. This method ensures that the engine is destroyed properly.

Overrides:

finalize in class Object

Throws:

Throwable