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

Class GraphvizConfigVisitor

java.lang.Object

org.apache.reef.tang.util.walk.AbstractClassHierarchyNodeVisitor

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

All Implemented Interfaces:

EdgeVisitor<Node>, NodeVisitor<Node>

public final class GraphvizConfigVisitor
extends AbstractClassHierarchyNodeVisitor
implements EdgeVisitor<Node>

Build a Graphviz representation of the configuration graph.

Constructor Summary

Constructors

Constructor and Description
GraphvizConfigVisitor(Configuration config, boolean showImpl, boolean showLegend) Create a new TANG configuration visitor.

Method Summary

Methods

Modifier and Type	Method and Description
static String	getGraphvizString(Configuration config, boolean showImpl, boolean showLegend) Produce a Graphviz DOT string for a given TANG configuration.
String	toString()
boolean	visit(ClassNode<?> node) Process current class configuration node.
boolean	visit(NamedParameterNode<?> node) Process current configuration node for the named parameter.
boolean	visit(Node nodeFrom, Node nodeTo) Process current edge of the configuration graph.
boolean	visit(PackageNode node) Process current package configuration node.

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

visit

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphvizConfigVisitor

public GraphvizConfigVisitor(Configuration config,
                     boolean showImpl,
                     boolean showLegend)

Create a new TANG configuration visitor.

Parameters:

config - Entire TANG configuration object.

showImpl - If true, plot IS-A edges for know implementations.

showLegend - If true, add legend to the plot.

Method Detail

getGraphvizString

public static String getGraphvizString(Configuration config,
                       boolean showImpl,
                       boolean showLegend)

Produce a Graphviz DOT string for a given TANG configuration.

Parameters:

config - TANG configuration object.

showImpl - If true, plot IS-A edges for know implementations.

showLegend - If true, add legend to the plot.

Returns:

configuration graph represented as a string in Graphviz DOT format.

toString

public String toString()

Overrides:

toString in class Object

Returns:

TANG configuration represented as a Graphviz DOT string.

visit

public boolean visit(ClassNode<?> node)

Process current class configuration node.

Specified by:

visit in class AbstractClassHierarchyNodeVisitor

Parameters:

node - Current configuration node.

Returns:

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

visit

public boolean visit(PackageNode node)

Process current package configuration node.

Specified by:

visit in class AbstractClassHierarchyNodeVisitor

Parameters:

node - Current configuration node.

Returns:

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

visit

public boolean visit(NamedParameterNode<?> node)

Process current configuration node for the named parameter.

Specified by:

visit in class AbstractClassHierarchyNodeVisitor

Parameters:

node - Current configuration node.

Returns:

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

visit

public boolean visit(Node nodeFrom,
            Node nodeTo)

Process current edge of the configuration graph.

Specified by:

visit in interface EdgeVisitor<Node>

Parameters:

nodeFrom - Current configuration node.

nodeTo - Destination configuration node.

Returns:

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