com.xpn.xwiki.plugin.graphviz
Class GraphVizPluginApi

java.lang.Object
  extended by com.xpn.xwiki.api.Api
      extended by com.xpn.xwiki.plugin.PluginApi<GraphVizPlugin>
          extended by com.xpn.xwiki.plugin.graphviz.GraphVizPluginApi

Deprecated. the plugin technology is deprecated

@Deprecated
public class GraphVizPluginApi
extends PluginApi<GraphVizPlugin>

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

Version:
$Id: 9a832b92a56613118e85b032a7e04216585039a1 $

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, 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

GraphVizPluginApi

public GraphVizPluginApi(GraphVizPlugin plugin,
                         XWikiContext context)
Deprecated. 
Default plugin API constructor.

Parameters:
plugin - the wrapped plugin instance
context - the current request context
Method Detail

getPlugin

public GraphVizPlugin getPlugin()
Deprecated. 
Return the inner plugin object, if the user has the required programming rights.

Returns:
The wrapped plugin object.

getDotImage

public byte[] getDotImage(String content,
                          boolean dot)
                   throws IOException
Deprecated. 
Executes GraphViz and return the content of the resulting image (PNG format).

Parameters:
content - the dot source code
dot - which engine to execute: dot if true, neato if false
Returns:
the content of the generated image
Throws:
IOException - if writing the input or output files to the disk fails

getDotImage

public byte[] getDotImage(String content,
                          String extension,
                          boolean dot)
                   throws IOException
Deprecated. 
Executes GraphViz and return the content of the resulting image (PNG format).

Parameters:
content - the dot source code
extension - the output file extension
dot - which engine to execute: dot if true, neato if false
Returns:
the content of the generated file
Throws:
IOException - if writing the input or output files to the disk fails

getDotImageURL

public String getDotImageURL(String content,
                             boolean dot)
                      throws IOException
Deprecated. 
Executes GraphViz and returns the URL for the produced file, a PNG image.

Parameters:
content - the dot source
dot - which engine to execute: dot if true, neato if false
Returns:
the URL which can be used to access the generated image
Throws:
IOException - if writing the input or output files to the disk fails

writeDotImage

public String writeDotImage(String content,
                            boolean dot)
                     throws IOException
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).

Parameters:
content - the dot source code
dot - which engine to execute: dot if true, neato if false
Returns:
the name of the file where the generated output is stored
Throws:
IOException - if writing the input or output files to the disk fails

writeDotImage

public String writeDotImage(String content,
                            String extension,
                            boolean dot)
                     throws IOException
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).

Parameters:
content - the dot source code
extension - the output file extension
dot - which engine to execute: dot if true, neato if false
Returns:
the name of the file where the generated output is stored
Throws:
IOException - if writing the input or output files to the disk fails

outputDotImage

public void outputDotImage(String content,
                           boolean dot)
                    throws IOException
Deprecated. 
Executes GraphViz and writes the resulting image (PNG format) into the response.

Parameters:
content - the dot source code
dot - which engine to execute: dot if true, neato if false
Throws:
IOException - if writing the input or output files to the disk fails, or if writing the response body fails

outputDotImage

public void outputDotImage(String content,
                           String extension,
                           boolean dot)
                    throws IOException
Deprecated. 
Executes GraphViz and writes the resulting image (in the requested format) into the response.

Parameters:
content - the dot source code
extension - the output file extension
dot - which engine to execute: dot if true, neato if false
Throws:
IOException - if writing the input or output files to the disk fails, or if writing the response body fails

flushCache

public void flushCache()
Deprecated. 
Discard all generated output from the temporary file storage.



Copyright © 2004-2013 XWiki. All Rights Reserved.