All Downloads are FREE. Search and download functionalities are using the official Maven repository.

freak.core.util.GraphViz Maven / Gradle / Ivy

There is a newer version: 0.4.7
Show newest version
/*
 * This file is part of RFrEAK. For licensing and copyright information
 * please see the file COPYING in the root directory of this
 * distribution or contact .
 *
 * This file is a modification of the original file by Laszlo Szathmary.
 * Last modification: 06/28/2007
 */


// GraphViz.java - a simple API to call dot from Java programs

/*$Id: GraphViz.java,v 1.2 2007/11/28 13:38:08 nunkesse Exp $*/
/*
 ******************************************************************************
 *                                                                            *
 *              (c) Copyright 2003 Laszlo Szathmary                           *
 *                                                                            *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms of the GNU Lesser General Public License as published by   *
 * the Free Software Foundation; either version 2.1 of the License, or        *
 * (at your option) any later version.                                        *
 *                                                                            *
 * This program is distributed in the hope that it will be useful, but        *
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public    *
 * License for more details.                                                  *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public License   *
 * along with this program; if not, write to the Free Software Foundation,    *
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                              *
 *                                                                            *
 ******************************************************************************
 */
package freak.core.util;
import java.io.*;

/**
 * 
*
Purpose: GraphViz Java API *
* *
Description: *
With this Java class you can simply call dot * from your Java programs *
Example usage: *
*
 *    GraphViz gv = new GraphViz();
 *    gv.addln(gv.start_graph());
 *    gv.addln("A  B;");
 *    gv.addln("A  C;");
 *    gv.addln(gv.end_graph());
 *    System.out.println(gv.getDotSource());
 *
 *    File out = new File("out.gif");
 *    gv.writeGraphToFile(gv.getGraph(gv.getDotSource()), out);
 * 
*
* *
* * @version v0.1, 2003/12/04 (Decembre) * @author Laszlo Szathmary ([email protected]) */ public class GraphViz { /** * The dir where temporary files will be created. */ private static String TEMP_DIR = "/tmp"; /** * Where is your dot program located? It will be called externally. */ public static String DOT = "/usr/bin/dot"; /** * The source of the graph written in dot language. */ private StringBuffer graph = new StringBuffer(); /** * Constructor: creates a new GraphViz object that will contain * a graph. */ public GraphViz() { } /** * Returns the graph's source description in dot language. * @return Source of the graph in dot language. */ public String getDotSource() { return graph.toString(); } /** * Adds a string to the graph's source (without newline). */ public void add(String line) { graph.append(line); } /** * Adds a string to the graph's source (with newline). */ public void addln(String line) { graph.append(line+"\n"); } /** * Adds a newline to the graph's source. */ public void addln() { graph.append('\n'); } /** * Returns the graph as an image in binary format. * @param dot_source Source of the graph to be drawn. * @return A byte array containing the image of the graph. */ public byte[] getGraph(String dot_source) { File dot; byte[] img_stream = null; try { dot = writeDotSourceToFile(dot_source); if (dot != null) { img_stream = get_img_stream(dot); if (dot.delete() == false) System.err.println("Warning: "+dot.getAbsolutePath()+" could not be deleted!"); return img_stream; } return null; } catch (IOException ioe) { return null; } } /** * Writes the graph's image in a file. * @param img A byte array containing the image of the graph. * @param file Name of the file to where we want to write. * @return Success: 1, Failure: -1 */ public int writeGraphToFile(byte[] img, String file) { File to = new File(file); return writeGraphToFile(img, to); } /** * Writes the graph's image in a file. * @param img A byte array containing the image of the graph. * @param to A File object to where we want to write. * @return Success: 1, Failure: -1 */ public int writeGraphToFile(byte[] img, File to) { try { FileOutputStream fos = new FileOutputStream(to); fos.write(img); fos.close(); } catch (IOException ioe) { return -1; } return 1; } /** * It will call the external dot program, and return the image in * binary format. * @param dot Source of the graph (in dot language). * @return The image of the graph in .gif format. */ private byte[] get_img_stream(File dot) { File img; byte[] img_stream = null; try { img = File.createTempFile("graph_", ".gif", new File(this.TEMP_DIR)); String temp = img.getAbsolutePath(); Runtime rt = Runtime.getRuntime(); String cmd = DOT + " -Tgif "+dot.getAbsolutePath()+" -o"+img.getAbsolutePath(); Process p = rt.exec(cmd); p.waitFor(); FileInputStream in = new FileInputStream(img.getAbsolutePath()); img_stream = new byte[in.available()]; in.read(img_stream); // Close it if we need to if( in != null ) in.close(); if (img.delete() == false) System.err.println("Warning: "+img.getAbsolutePath()+" could not be deleted!"); } catch (IOException ioe) { // System.err.println("Error: in I/O processing of tempfile in dir "+this.TEMP_DIR+"\n"); // System.err.println(" or in calling external command"); // ioe.printStackTrace(); } catch (InterruptedException ie) { System.err.println("Error: the execution of the external program was interrupted"); ie.printStackTrace(); } return img_stream; } /** * Writes the source of the graph in a file, and returns the written file * as a File object. * @param str Source of the graph (in dot language). * @return The file (as a File object) that contains the source of the graph. */ private File writeDotSourceToFile(String str) throws IOException { File temp; try { temp = File.createTempFile("graph_", ".dot.tmp", new File(this.TEMP_DIR)); FileWriter fout = new FileWriter(temp); fout.write(str); fout.close(); } catch (Exception e) { System.err.println("Error: I/O error while writing the dot source to temp file!"); return null; } return temp; } /** * Returns a string that is used to start a graph. * @return A string to open a graph. */ public String start_graph() { return "digraph G {"; } /** * Returns a string that is used to end a graph. * @return A string to close a graph. */ public String end_graph() { return "}"; } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy