|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.beandoc.output.DocumentCompilerImpl
public class DocumentCompilerImpl
Default implementation of the DocumentCompiler
interface. This class
invokes the GraphViz binary (where suitably configured) to create the graphs
and image map HTML from the generated .dot files. Further, it copies media
resources from the BeanDoc jar file to the output location.
Field Summary | |
---|---|
protected org.apache.commons.logging.Log |
logger
|
Constructor Summary | |
---|---|
DocumentCompilerImpl()
|
Method Summary | |
---|---|
void |
compile(org.jdom.Document[] contextDocuments,
File outputDir)
Generates actual images and HTML image maps (as required) from the dot files created by DotFileTransformer. |
String |
getDotExe()
Location of the GraphViz 'dot' executable program on the local machine |
String |
getDotFileMapFormat()
|
boolean |
isRemoveDotFiles()
Should intermediate .dot files be removed? |
void |
setDotExe(String dotExe)
Set the location of the 'dot' executable file from the Graphviz installation. |
void |
setDotFileExtension(String dotFileExtension)
sets the file extension of Graphviz 'dot' files. |
void |
setDotFileMapFormat(String dotFileMapFormat)
The image map format that Dot should use to generate an image map for the context graphs. |
void |
setFilenameStrategy(org.springframework.beandoc.output.FilenameStrategy filenameStrategy)
set a filename strategy for output files generated by this class |
void |
setRemoveDotFiles(boolean removeDotFiles)
A series of intermediate files (.dot files) are created which is what GraphViz uses to actually generate the graphs. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final org.apache.commons.logging.Log logger
Constructor Detail |
---|
public DocumentCompilerImpl()
Method Detail |
---|
public void compile(org.jdom.Document[] contextDocuments, File outputDir)
compile
in interface DocumentCompiler
DocumentCompiler.compile(Document[],
File)
public void setDotExe(String dotExe)
Runtime.getRuntime().exec(...)
call. If this value is not
set, graphing output will be disabled.
dotExe
- the platform dependent location of the binary, ie
"/usr/local/bin/dot" or "C:/graphviz/dot.exe"public void setRemoveDotFiles(boolean removeDotFiles)
false
removeDotFiles
- set to false to prevent intermediate .dot files
being discarded. True by default.public String getDotExe()
public boolean isRemoveDotFiles()
public String getDotFileMapFormat()
public void setDotFileMapFormat(String dotFileMapFormat)
dotFileMapFormat
- the format string to denote output type of the
image mappublic void setDotFileExtension(String dotFileExtension)
dotFileExtension
- the extension to usepublic void setFilenameStrategy(org.springframework.beandoc.output.FilenameStrategy filenameStrategy)
filenameStrategy
- the filename strategy to be used
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |