org.apache.oozie.util.graph

Class GraphGenerator

java.lang.Object

org.apache.oozie.util.graph.GraphGenerator

public class GraphGenerator
extends Object

Class to generate and plot runtime workflow DAG.

Since it delegates to WorkflowGraphHandler and a GraphRenderer, it is the single entry point when changing graph generation behavior.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SAX_FEATURE_DISALLOW_DOCTYPE_DECL
static String	SAX_FEATURE_EXTERNAL_GENERAL_ENTITIES
static String	SAX_FEATURE_EXTERNAL_PARAMETER_ENTITIES

Constructor Summary

Constructors

Constructor and Description
GraphGenerator(String xml, WorkflowJob job, boolean showKill, GraphRenderer graphRenderer) Constructor Inversion of Control-style for better testability.

Method Summary

Modifier and Type	Method and Description
void	write(OutputStream out, OutputFormat outputFormat) Stream the generated PNG, DOT or SVG stream to the caller.

Methods inherited from class java.lang.Object

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

Field Detail

SAX_FEATURE_EXTERNAL_GENERAL_ENTITIES

public static final String SAX_FEATURE_EXTERNAL_GENERAL_ENTITIES

See Also:

Constant Field Values

SAX_FEATURE_EXTERNAL_PARAMETER_ENTITIES

public static final String SAX_FEATURE_EXTERNAL_PARAMETER_ENTITIES

See Also:

Constant Field Values

SAX_FEATURE_DISALLOW_DOCTYPE_DECL

public static final String SAX_FEATURE_DISALLOW_DOCTYPE_DECL

See Also:

Constant Field Values

Constructor Detail

GraphGenerator

public GraphGenerator(String xml,
                      WorkflowJob job,
                      boolean showKill,
                      GraphRenderer graphRenderer)

Constructor Inversion of Control-style for better testability.

Parameters:

xml - The workflow definition XML

job - Current status of the job

showKill - Flag to whether show 'kill' node

graphRenderer - the renderer

Method Detail

write

public void write(OutputStream out,
                  OutputFormat outputFormat)
           throws ParserConfigurationException,
                  SAXException,
                  IOException

Stream the generated PNG, DOT or SVG stream to the caller. Note that closing the OutputStream is the responsibility of the caller.

Parameters:

out - the OutputStream to use on streaming

outputFormat - The output format to apply when rendering

Throws:

ParserConfigurationException - if the parser is not configured properly

SAXException - in case of XML error

IOException - in case of any other IO related issues