org.quattor.pan.output
Class DotFormatter

java.lang.Object
  org.quattor.pan.output.DotFormatter

All Implemented Interfaces:

Formatter

public class DotFormatter
extends java.lang.Object
implements Formatter

A formatter that will transform a machine profile into a graph in dot syntax. The dot syntax is that used by GraphViz.

Author:

loomis

Method Summary

java.lang.String	getFileExtension() Return the file extension for files written with this formatter.
java.lang.String	getFormatKey() Returns the name of the formatter that will be used to identify it.
static DotFormatter	getInstance()
void	write(Element root, java.lang.String rootName, java.io.PrintWriter ps) Reads this Tree and writes it in a file within the given context.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DotFormatter getInstance()

getFileExtension

public java.lang.String getFileExtension()

Description copied from interface: Formatter

Return the file extension for files written with this formatter. The implementation may not return null.

Specified by:

getFileExtension in interface Formatter

Returns:

String containing the file extension to use

getFormatKey

public java.lang.String getFormatKey()

Description copied from interface: Formatter

Returns the name of the formatter that will be used to identify it. This key is used as the value for the command line and for the ant task. The returned key must not be null.

Specified by:

getFormatKey in interface Formatter

Returns:

String identifying this formatter

write

public void write(Element root,
                  java.lang.String rootName,
                  java.io.PrintWriter ps)

Description copied from interface: Formatter

Reads this Tree and writes it in a file within the given context.

Specified by:

write in interface Formatter

Parameters:

root - root element of the configuration tree

rootName - name of root element

ps - the PrintStream used to write the file