com.atlassian.maven.plugins.depgraph.export

Class VisDiagramExporter

java.lang.Object

com.atlassian.maven.plugins.depgraph.export.VisDiagramExporter

All Implemented Interfaces:

DiagramExporter

public class VisDiagramExporter
extends Object
implements DiagramExporter

Export a standalone HTML with a diagram based in the "network" type of diagram of the JS library Vis.js

TODO: rewrite this class to use a template engine.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,GraphNode>	graphNodeMap
protected File	outputDirectory

Constructor Summary

Constructors

Constructor and Description
VisDiagramExporter(Map<String,GraphNode> graphNodeMap, File outputDirectory)

Method Summary

Modifier and Type	Method and Description
void	execute(GraphNode rootNode) Outputs the `graph.html` file to the output directory of the project using the parameter rootNode as the root element of the graph.
protected org.apache.maven.plugin.logging.Log	getLog()
protected void	printFooter(FileWriter writer)
protected void	printGraphData(GraphNode rootNode, FileWriter writer)
protected void	printHeader(FileWriter writer)

Methods inherited from class java.lang.Object

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

Field Detail

graphNodeMap

protected final Map<String,GraphNode> graphNodeMap

outputDirectory

protected final File outputDirectory

Constructor Detail

VisDiagramExporter

public VisDiagramExporter(Map<String,GraphNode> graphNodeMap,
                          File outputDirectory)

Method Detail

execute

public void execute(GraphNode rootNode)
             throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: DiagramExporter

Outputs the `graph.html` file to the output directory of the project using the parameter rootNode as the root element of the graph.

Specified by:

execute in interface DiagramExporter

Parameters:

rootNode - the root element of the graph.

Throws:

org.apache.maven.plugin.MojoExecutionException - when unexpected errors occur during the execution of the Maven plugin

See Also:

DiagramExporter

printHeader

protected void printHeader(FileWriter writer)
                    throws IOException

Throws:

IOException

printGraphData

protected void printGraphData(GraphNode rootNode,
                              FileWriter writer)
                       throws IOException

Throws:

IOException

printFooter

protected void printFooter(FileWriter writer)
                    throws IOException

Throws:

IOException

getLog

protected org.apache.maven.plugin.logging.Log getLog()