net.kemitix.dependency.digraph.maven.plugin.digraph

Class Subgraph

java.lang.Object

net.kemitix.dependency.digraph.maven.plugin.digraph.Subgraph

All Implemented Interfaces:

EdgeEndpoint, ElementContainer, GraphElement, HasId, HasLabel, HasPackageDataNode

@Immutable
public class Subgraph
extends Object
implements ElementContainer, HasId, HasLabel, EdgeEndpoint

Represets a subgraph/cluster.

Author:

Paul Campbell (pcampbell@kemitix.net)

Constructor Summary

Constructors

Constructor and Description
Subgraph(net.kemitix.node.Node<PackageData> packageDataNode, String id, String label, DotFileFormat dotFileFormat) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(GraphElement graphElement) Adds an element to the container.
String	render() Render the graph element for use in a DotFile.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kemitix.dependency.digraph.maven.plugin.digraph.ElementContainer

getElements

Methods inherited from interface net.kemitix.dependency.digraph.maven.plugin.digraph.HasLabel

getLabel

Methods inherited from interface net.kemitix.dependency.digraph.maven.plugin.digraph.HasPackageDataNode

getPackageDataNode

Methods inherited from interface net.kemitix.dependency.digraph.maven.plugin.digraph.HasId

getId

Constructor Detail

Subgraph

public Subgraph(net.kemitix.node.Node<PackageData> packageDataNode,
                String id,
                String label,
                DotFileFormat dotFileFormat)

Constructor.

Parameters:

packageDataNode - the package data node for this subgraph

id - the id of the subgraph

label - the label of the subgraph

dotFileFormat - the output format

Method Detail

add

public final boolean add(GraphElement graphElement)

Description copied from interface: ElementContainer

Adds an element to the container.

Specified by:

add in interface ElementContainer

Parameters:

graphElement - the element to add

Returns:

true if the element was added

render

public final String render()

Description copied from interface: GraphElement

Render the graph element for use in a DotFile.

Specified by:

render in interface GraphElement

Returns:

the rendered graph element