DOT (AutomataLib :: Parent 0.3.1 API)

java.lang.Object
- net.automatalib.commons.dotutil.DOT

```
public class DOT
extends Object
```
Utility class to simplify operating the GraphVIZ "dot" utility. Please note that all of the provided methods require GraphVIZ to be installed on the system, and that the "dot" binary resides in the execution path.

Author:

Malte Isberner

Constructor Summary

Constructors
Constructor and Description

DOT()

Constructors
Constructor and Description
`DOT()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DOTComponent`	`createDOTComponent(Reader r)` Creates a `DOTComponent` that displays the result of rendering a DOT description read from a `Reader`.
`static Writer`	`createDotWriter(boolean modal)` Creates a Writer that can be used to write a DOT description to.
`static Process`	`executeDOT(String format, String... additionalOpts)`
`static void`	`renderDOT(File dotFile, boolean modal)` Renders a GraphVIZ description from a string and displays it in a Swing window.
`static void`	`renderDOT(Reader r, boolean modal)` Renders a GraphVIZ description and displays it in a Swing window.
`static void`	`renderDOT(String dotText, boolean modal)` Renders a GraphVIZ description from a string and displays it in a Swing window.
`static void`	`renderDOTExternal(File dotFile, String format)` Renders a GraphVIZ description from a file, using an external program for displaying.
`static void`	`renderDOTExternal(Reader r, String format)` Renders a GraphVIZ description, using an external program for displaying.
`static void`	`renderDOTExternal(String dotText, String format)` Renders a GraphVIZ description from a string, using an external program for displaying.
`static BufferedImage`	`renderDOTImage(File dotFile)` Reads a DOT description from a file and returns the PNG rendering result as a `BufferedImage`.
`static BufferedImage`	`renderDOTImage(Reader dotReader)` Reads a DOT description from a reader and returns the PNG rendering result as a `BufferedImage`.
`static BufferedImage`	`renderDOTImage(String dotText)` Reads a DOT description from a string and returns the PNG rendering result as a `BufferedImage`.
`static void`	`runDOT(File dotFile, String format, File out)` Invokes the DOT utility on a file, producing an output file.
`static InputStream`	`runDOT(File dotFile, String format, String... additionalOpts)` Invokes the DOT utility on a file.
`static void`	`runDOT(Reader r, String format, File out)` Invokes the GraphVIZ DOT utility for rendering graphs, writing output to the specified file.
`static InputStream`	`runDOT(Reader r, String format, String... additionalOpts)` Invokes the GraphVIZ DOT utility for rendering graphs.
`static void`	`runDOT(String dotText, String format, File out)` Invokes the DOT utility on a string, producing an output file.
`static InputStream`	`runDOT(String dotText, String format, String... additionalOpts)` Invokes the DOT utility on a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DOT
```
public DOT()
```
- Method Detail
  - executeDOT
```
public static Process executeDOT(String format,
                                 String... additionalOpts)
                          throws IOException
```
    Throws:
    
    IOException
  - runDOT
```
public static InputStream runDOT(Reader r,
                                 String format,
                                 String... additionalOpts)
                          throws IOException
```
    Invokes the GraphVIZ DOT utility for rendering graphs.
    
    Parameters:
    
    r - the reader from which the GraphVIZ description is obtained.
    
    format - the output format, as understood by the dot utility, e.g., png, ps, ...
    
    Returns:
    
    an input stream from which the image data can be read.
    
    Throws:
    
    IOException - if reading from the specified reader fails.
  - runDOT
```
public static InputStream runDOT(String dotText,
                                 String format,
                                 String... additionalOpts)
                          throws IOException
```
    Invokes the DOT utility on a string. Convenience method, see #runDOT(Reader, String).
    
    Throws:
    
    IOException
  - runDOT
```
public static InputStream runDOT(File dotFile,
                                 String format,
                                 String... additionalOpts)
                          throws IOException
```
    Invokes the DOT utility on a file. Convenience method, see #runDOT(Reader, String).
    
    Throws:
    
    IOException
  - runDOT
```
public static void runDOT(Reader r,
                          String format,
                          File out)
                   throws IOException
```
    Invokes the GraphVIZ DOT utility for rendering graphs, writing output to the specified file.
    
    Parameters:
    
    r - the reader from which the GraphVIZ description is read.
    
    format - the output format to produce.
    
    out - the file to which the output is written.
    
    Throws:
    
    IOException - if an I/O error occurs reading from the given input or writing to the output file.
  - runDOT
```
public static void runDOT(String dotText,
                          String format,
                          File out)
                   throws IOException
```
    Invokes the DOT utility on a string, producing an output file. Convenience method, see runDOT(Reader, String, File).
    
    Throws:
    
    IOException
  - runDOT
```
public static void runDOT(File dotFile,
                          String format,
                          File out)
                   throws IOException,
                          FileNotFoundException
```
    Invokes the DOT utility on a file, producing an output file. Convenience method, see runDOT(Reader, String, File).
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - renderDOTExternal
```
public static void renderDOTExternal(Reader r,
                                     String format)
```
    Renders a GraphVIZ description, using an external program for displaying. The program is determined by the system's file type associations, using the Desktop.open(File) method.
    
    Parameters:
    
    r - the reader from which the GraphVIZ description is read.
    
    format - the output format, as understood by the dot utility, e.g., png, ps, ...
  - renderDOTExternal
```
public static void renderDOTExternal(String dotText,
                                     String format)
```
    Renders a GraphVIZ description from a string, using an external program for displaying. Convenience method, see renderDOTExternal(Reader, String).
  - renderDOTExternal
```
public static void renderDOTExternal(File dotFile,
                                     String format)
                              throws FileNotFoundException
```
    Renders a GraphVIZ description from a file, using an external program for displaying. Convenience method, see renderDOTExternal(Reader, String).
    
    Throws:
    
    FileNotFoundException - if the specified file was not found.
  - renderDOT
```
public static void renderDOT(Reader r,
                             boolean modal)
```
    Renders a GraphVIZ description and displays it in a Swing window.
    
    Parameters:
    
    r - the reader from which the description is obtained.
    
    modal - whether or not the dialog should be modal.
  - renderDOT
```
public static void renderDOT(String dotText,
                             boolean modal)
```
    Renders a GraphVIZ description from a string and displays it in a Swing window. Convenience method, see renderDOT(Reader, boolean).
  - renderDOT
```
public static void renderDOT(File dotFile,
                             boolean modal)
                      throws FileNotFoundException
```
    Renders a GraphVIZ description from a string and displays it in a Swing window. Convenience method, see renderDOT(Reader, boolean).
    
    Throws:
    
    FileNotFoundException - if the specified file was not found.
  - renderDOTImage
```
public static BufferedImage renderDOTImage(Reader dotReader)
                                    throws IOException
```
    Reads a DOT description from a reader and returns the PNG rendering result as a BufferedImage.
    
    Parameters:
    
    dotReader - the reader from which to read the description
    
    Returns:
    
    the rendering result
    
    Throws:
    
    IOException - if reading from the reader fails, or the pipe to the DOT process breaks.
  - renderDOTImage
```
public static BufferedImage renderDOTImage(String dotText)
                                    throws IOException
```
    Reads a DOT description from a string and returns the PNG rendering result as a BufferedImage.
    
    Parameters:
    
    dotText - the DOT description
    
    Returns:
    
    the rendering result
    
    Throws:
    
    IOException - if the pipe to the DOT process breaks.
  - renderDOTImage
```
public static BufferedImage renderDOTImage(File dotFile)
                                    throws IOException
```
    Reads a DOT description from a file and returns the PNG rendering result as a BufferedImage.
    
    Parameters:
    
    dotFile - the file containing the DOT description
    
    Returns:
    
    the rendering result
    
    Throws:
    
    IOException - if reading from the file fails or the pipe to the DOT process breaks.
  - createDOTComponent
```
public static DOTComponent createDOTComponent(Reader r)
```
    Creates a DOTComponent that displays the result of rendering a DOT description read from a Reader.
    
    Parameters:
    
    r - the reader to read from
    
    Returns:
    
    the DOT component
  - createDotWriter
```
public static Writer createDotWriter(boolean modal)
```
    Creates a Writer that can be used to write a DOT description to. Upon closing the writer, a window with the rendering result appears.
    
    Parameters:
    
    modal - whether or not this window is modal (if set to true, calls to Writer.close() will block.
    
    Returns:
    
    the writer

Class DOT

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DOT

Method Detail

executeDOT

runDOT

runDOT

runDOT

runDOT

runDOT

runDOT

renderDOTExternal

renderDOTExternal

renderDOTExternal

renderDOT

renderDOT

renderDOT

renderDOTImage

renderDOTImage

renderDOTImage

createDOTComponent

createDotWriter