aud.util.Graphviz Class Reference

Use GraphViz to render graph structures. More...

Collaboration diagram for aud.util.Graphviz:

Public Member Functions
File	renderDotFileToFile (File dotfile, String format)
	Render dot file. More...
void	displayAsPDF (String dotCode)
	Render and display dotCode. More...
void	displayAsPDF (Graphvizable object)
	Display object. More...
DotViewer	display (String dotCode)
	Render and display dotCode. More...
DotViewer	display (Graphvizable object)
	Display object. More...

Detailed Description

Use GraphViz to render graph structures.

Requires an installation of GraphViz.

See also

Sys

Sys.ExternalProgram

Graphvizable

DotViewer

Definition at line 15 of file Graphviz.java.

Member Function Documentation

display() [1/2]

DotViewer aud.util.Graphviz.display

(

Graphvizable

object

)

Display object.

Returns

viewer instance

Definition at line 87 of file Graphviz.java.

                                                {
    return DotViewer.displayWindow(object,"aud.util.DotViewer");
  }

References aud.util.DotViewer.displayWindow().

Here is the call graph for this function:

display() [2/2]

DotViewer aud.util.Graphviz.display

(

String

dotCode

)

Render and display dotCode.

Returns

viewer instance

Definition at line 81 of file Graphviz.java.

                                           {
    return DotViewer.displayWindow(dotCode,"aud.util.DotViewer");
  }

References aud.util.DotViewer.displayWindow().

Here is the call graph for this function:

displayAsPDF() [1/2]

void aud.util.Graphviz.displayAsPDF

(

Graphvizable

object

)

Display object.

See also

displayAsPDF

Definition at line 75 of file Graphviz.java.

                                                {
    displayAsPDF(object.toDot());
  }

References aud.util.Graphviz.displayAsPDF().

Here is the call graph for this function:

displayAsPDF() [2/2]

void aud.util.Graphviz.displayAsPDF

(

String

dotCode

)

Render and display dotCode.

Bug:

The generated PDF file is not removed! (There is no portable and trivial way to ensure removal.)

Definition at line 65 of file Graphviz.java.

                                           {
    File dotfile=Sys.writeToTempFile(dotCode,".dot");
    File pdffile=renderDotFileToFile(dotfile,"pdf");
    //dotfile.delete();
    Sys.viewPDFFile(pdffile.getPath());
  }

References aud.util.Graphviz.renderDotFileToFile(), aud.util.Sys.viewPDFFile(), and aud.util.Sys.writeToTempFile().

Referenced by aud.util.Graphviz.displayAsPDF().

Here is the call graph for this function:

Here is the caller graph for this function:

renderDotFileToFile()

File aud.util.Graphviz.renderDotFileToFile	(	File	dotfile,
		String	format
	)

Render dot file.

Excutes GraphViz dot and writes an output file ditfile+"."+format.

Definition at line 36 of file Graphviz.java.

                                                              {
    File out=new File(dotfile.getPath()+"."+format);
    String command=DOT.getPath()+" -T"+format+" "+dotfile.getPath()+" -o "+out;
    //System.err.println(command);
    // note: command is obsolete (used only in error message)
    try {
      ProcessBuilder pb = new ProcessBuilder
        (DOT.getPath(),"-T" + format,dotfile.getPath(),"-o",out.getPath());
      Process dot=pb.start();
 
      if (dot.waitFor()!=0) {
        System.err.println("ERROR: '"+command+"' failed");
      }
    }
    catch (IOException e) {
      System.err.println("ERROR: "+e.getMessage());
      return null; // note: probably triggers NullPointerException
    }
    catch (InterruptedException e) {
      System.err.println("ERROR: "+e.getMessage());
      return null; // note: probably triggers NullPointerException
    }
    return out;
  }

Referenced by aud.util.DotViewer.display(), and aud.util.Graphviz.displayAsPDF().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• Graphviz.java