org.apache.reef.tang.util.walk.graphviz

Class GraphvizInjectionPlanVisitor

java.lang.Object

org.apache.reef.tang.util.walk.AbstractInjectionPlanNodeVisitor

org.apache.reef.tang.util.walk.graphviz.GraphvizInjectionPlanVisitor

All Implemented Interfaces:

EdgeVisitor<InjectionPlan<?>>, NodeVisitor<InjectionPlan<?>>

public final class GraphvizInjectionPlanVisitor
extends AbstractInjectionPlanNodeVisitor
implements EdgeVisitor<InjectionPlan<?>>

Build a Graphviz representation of the injection plan graph.

Constructor Summary

Constructors

Constructor and Description
GraphvizInjectionPlanVisitor(boolean showLegend) Create a new visitor to build a graphviz string for the injection plan.

Method Summary

Methods

Modifier and Type	Method and Description
static String	getGraphvizString(InjectionPlan<?> injectionPlan, boolean showLegend) Produce a Graphviz DOT string for a given TANG injection plan.
String	toString()
boolean	visit(Constructor<?> node) Process current injection plan node of Constructor type.
boolean	visit(InjectionPlan<?> nodeFrom, InjectionPlan<?> nodeTo) Process current edge of the injection plan.
boolean	visit(JavaInstance<?> node) Process current injection plan node of JavaInstance type.
boolean	visit(Subplan<?> node) Process current injection plan node of Subplan type.

Methods inherited from class org.apache.reef.tang.util.walk.AbstractInjectionPlanNodeVisitor

visit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GraphvizInjectionPlanVisitor

public GraphvizInjectionPlanVisitor(boolean showLegend)

Create a new visitor to build a graphviz string for the injection plan.

Parameters:

showLegend - if true, show legend on the graph.

Method Detail

getGraphvizString

public static String getGraphvizString(InjectionPlan<?> injectionPlan,
                       boolean showLegend)

Produce a Graphviz DOT string for a given TANG injection plan.

Parameters:

injectionPlan - TANG injection plan.

showLegend - if true, show legend on the graph.

Returns:

Injection plan represented as a string in Graphviz DOT format.

visit

public boolean visit(Constructor<?> node)

Process current injection plan node of Constructor type.

Specified by:

visit in class AbstractInjectionPlanNodeVisitor

Parameters:

node - Current injection plan node.

Returns:

true to proceed with the next node, false to cancel.

visit

public boolean visit(JavaInstance<?> node)

Process current injection plan node of JavaInstance type.

Specified by:

visit in class AbstractInjectionPlanNodeVisitor

Parameters:

node - Current injection plan node.

Returns:

true to proceed with the next node, false to cancel.

visit

public boolean visit(Subplan<?> node)

Process current injection plan node of Subplan type.

Specified by:

visit in class AbstractInjectionPlanNodeVisitor

Parameters:

node - Current injection plan node.

Returns:

true to proceed with the next node, false to cancel.

visit

public boolean visit(InjectionPlan<?> nodeFrom,
            InjectionPlan<?> nodeTo)

Process current edge of the injection plan.

Specified by:

visit in interface EdgeVisitor<InjectionPlan<?>>

Parameters:

nodeFrom - Current injection plan node.

nodeTo - Destination injection plan node.

Returns:

true to proceed with the next node, false to cancel.

toString

public String toString()

Overrides:

toString in class Object

Returns:

TANG injection plan represented as a Graphviz DOT string.