|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.PluginApi<GraphVizPlugin>
com.xpn.xwiki.plugin.graphviz.GraphVizPluginApi
@Deprecated public class GraphVizPluginApi
Plugin which wraps the GraphViz dot executable; transforming dot source files (representing graphs) into images, image maps, or other output formats supported by GraphViz.
See http://www.graphviz.org/doc/info/lang.html for the dot language specification. See http://www.graphviz.org/doc/info/output.html for the possible output formats
Field Summary |
---|
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
GraphVizPluginApi(GraphVizPlugin plugin,
XWikiContext context)
Deprecated. Default plugin API constructor. |
Method Summary | |
---|---|
void |
flushCache()
Deprecated. Discard all generated output from the temporary file storage. |
byte[] |
getDotImage(String content,
boolean dot)
Deprecated. Executes GraphViz and return the content of the resulting image (PNG format). |
byte[] |
getDotImage(String content,
String extension,
boolean dot)
Deprecated. Executes GraphViz and return the content of the resulting image (PNG format). |
String |
getDotImageURL(String content,
boolean dot)
Deprecated. Executes GraphViz and returns the URL for the produced file, a PNG image. |
GraphVizPlugin |
getPlugin()
Deprecated. Return the inner plugin object, if the user has the required programming rights. |
void |
outputDotImage(String content,
boolean dot)
Deprecated. Executes GraphViz and writes the resulting image (PNG format) into the response. |
void |
outputDotImage(String content,
String extension,
boolean dot)
Deprecated. Executes GraphViz and writes the resulting image (in the requested format) into the response. |
String |
writeDotImage(String content,
boolean dot)
Deprecated. Executes GraphViz, writes the resulting image (PNG format) in a temporary file on disk, and returns the filename which can be later used in #outputDotImageFromFile(String, XWikiContext) . |
String |
writeDotImage(String content,
String extension,
boolean dot)
Deprecated. Executes GraphViz, writes the resulting image (in the requested format) in a temporary file on disk, and returns the filename which can be later used in #outputDotImageFromFile(String, XWikiContext) . |
Methods inherited from class com.xpn.xwiki.plugin.PluginApi |
---|
getInternalPlugin, getProtectedPlugin, setPlugin |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
convert, convert, convert, convertAttachments, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GraphVizPluginApi(GraphVizPlugin plugin, XWikiContext context)
plugin
- the wrapped plugin instancecontext
- the current request contextMethod Detail |
---|
public GraphVizPlugin getPlugin()
public byte[] getDotImage(String content, boolean dot) throws IOException
content
- the dot source codedot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk failspublic byte[] getDotImage(String content, String extension, boolean dot) throws IOException
content
- the dot source codeextension
- the output file extensiondot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk failspublic String getDotImageURL(String content, boolean dot) throws IOException
content
- the dot sourcedot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk failspublic String writeDotImage(String content, boolean dot) throws IOException
#outputDotImageFromFile(String, XWikiContext)
.
content
- the dot source codedot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk failspublic String writeDotImage(String content, String extension, boolean dot) throws IOException
#outputDotImageFromFile(String, XWikiContext)
.
content
- the dot source codeextension
- the output file extensiondot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk failspublic void outputDotImage(String content, boolean dot) throws IOException
content
- the dot source codedot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk fails, or if writing the response body failspublic void outputDotImage(String content, String extension, boolean dot) throws IOException
content
- the dot source codeextension
- the output file extensiondot
- which engine to execute: dot
if true
, neato
if false
IOException
- if writing the input or output files to the disk fails, or if writing the response body failspublic void flushCache()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |