Package org.frankframework.util.flow.graphviz

Class GraphvizEngine

java.lang.Object

org.frankframework.util.flow.graphviz.GraphvizEngine

public class GraphvizEngine
extends Object

JavaScript engine wrapper for VizJs flow diagrams

Author:

Niels Meijer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()	Shuts down the GraphvizEngine instance properly.
String	execute(String src)	Execute GraphViz with default options (Format.SVG)
String	execute(String src, Options options)	Execute GraphViz

Methods inherited from class java.lang.Object

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

Constructor Details

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 VisJs engine to initiate

Throws:

IOException

Method Details

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 properly. The GraphvizJsFlowGenerator uses a ThreadLocal+SoftReference map to cache the GraphvisEngines. This method ensures that the used Javascript engine is destroyed properly.