net.sourceforge.schemaspy.util

クラス Dot

java.lang.Object

net.sourceforge.schemaspy.util.Dot

public class Dot
extends Object

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
class	Dot.DotFailure

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	exists()
String	generateDiagram(File dotFile, File diagramFile) Using the specified .dot file generates an image returning the image's image map.
String	getFormat()
static Dot	getInstance()
String	getRenderer()
String	getSupportedVersions()
Version	getVersion()
boolean	isHighQuality()
boolean	isValid()
boolean	requiresGdRenderer() Returns true if the installed dot requires specifying :gd as a renderer.
void	setFormat(String format) Set the image format to generate.
void	setHighQuality(boolean highQuality) If true then generate output of "higher quality" than the default ("lower quality").
void	setRenderer(String renderer) Set the renderer to use for the -Tformat[:renderer[:formatter]] dot option as specified at http://www.graphviz.org/doc/info/command.html where "format" is specified by setFormat(String) Note that the leading ":" is required while :formatter is optional.
boolean	supportsCenteredEastWestEdges()
boolean	supportsRenderer(String renderer) Returns true if the specified renderer is supported.

クラスから継承されたメソッド java.lang.Object

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

メソッドの詳細

getInstance

public static Dot getInstance()

exists

public boolean exists()

getVersion

public Version getVersion()

isValid

public boolean isValid()

getSupportedVersions

public String getSupportedVersions()

supportsCenteredEastWestEdges

public boolean supportsCenteredEastWestEdges()

setFormat

public void setFormat(String format)

Set the image format to generate. Defaults to png. See http://www.graphviz.org/doc/info/output.html for valid formats.

パラメータ:

format - image format to generate

getFormat

public String getFormat()

戻り値:

関連項目:

setFormat(String)

requiresGdRenderer

public boolean requiresGdRenderer()

Returns true if the installed dot requires specifying :gd as a renderer. This was added when Win 2.15 came out because it defaulted to Cairo, which produces better quality output, but at a significant speed and size penalty.

The intent of this property is to determine if it's ok to tack ":gd" to the format specifier. Earlier versions didn't require it and didn't know about the option.

戻り値:

setRenderer

public void setRenderer(String renderer)

Set the renderer to use for the -Tformat[:renderer[:formatter]] dot option as specified at http://www.graphviz.org/doc/info/command.html where "format" is specified by setFormat(String)

Note that the leading ":" is required while :formatter is optional.

パラメータ:

renderer -

getRenderer

public String getRenderer()

setHighQuality

public void setHighQuality(boolean highQuality)

If true then generate output of "higher quality" than the default ("lower quality"). Note that the default is intended to be "lower quality", but various installations of Graphviz may have have different abilities. That is, some might not have the "lower quality" libraries and others might not have the "higher quality" libraries.

isHighQuality

public boolean isHighQuality()

関連項目:

setHighQuality(boolean)

supportsRenderer

public boolean supportsRenderer(String renderer)

Returns true if the specified renderer is supported. See setRenderer(String) for renderer details.

パラメータ:

renderer -

戻り値:

generateDiagram

public String generateDiagram(File dotFile,
                              File diagramFile)
                       throws Dot.DotFailure

Using the specified .dot file generates an image returning the image's image map.

例外:

Dot.DotFailure