net.kemitix.dependency.digraph.maven.plugin

Interface DotFileFormat

All Known Implementing Classes:

AbstractDotFileFormat

public interface DotFileFormat

Interface for report generators in a specific format.

Author:

Paul Campbell (pcampbell@kemitix.net)

Method Summary

Modifier and Type	Method and Description
String	render(Digraph digraph) Render the digraph element as a string.
String	render(EdgeElement edgeElement) Render the edge element as a string.
String	render(NodeElement nodeElement) Render the node element as a string.
String	render(NodeProperties nodeProperties) Render the node properties as a string.
String	render(PropertyElement propertyElement) Render the property element as a string.
String	render(Subgraph subgraph) Render the subgraph as a string.
String	renderReport() Generates the report.

Method Detail

renderReport

String renderReport()

Generates the report.

Returns:

the formatted report

render

String render(Digraph digraph)

Render the digraph element as a string.

Parameters:

digraph - the digraph to render

Returns:

the rendered digraph

render

String render(EdgeElement edgeElement)

Render the edge element as a string.

Parameters:

edgeElement - the edge element to render

Returns:

the rendered edge element

render

String render(NodeElement nodeElement)

Render the node element as a string.

Parameters:

nodeElement - the node element to render

Returns:

the rendered node element

render

String render(NodeProperties nodeProperties)

Render the node properties as a string.

Parameters:

nodeProperties - the node properties to render

Returns:

the rendered node properties

render

String render(PropertyElement propertyElement)

Render the property element as a string.

Parameters:

propertyElement - the property element to render

Returns:

the rendered property element

render

String render(Subgraph subgraph)

Render the subgraph as a string.

Parameters:

subgraph - the subgraph to render

Returns:

the rendered subgraph