slib.graph.io.plotter.GraphPlotter_Graphviz Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slib-graph-io Show documentation
Graph I/O library which can be used to load and store graphs
The newest version!
/* 
 *  Copyright or © or Copr. Ecole des Mines d'Alès (2012-2014) 
 *  
 *  This software is a computer program whose purpose is to provide 
 *  several functionalities for the processing of semantic data 
 *  sources such as ontologies or text corpora.
 *  
 *  This software is governed by the CeCILL  license under French law and
 *  abiding by the rules of distribution of free software.  You can  use, 
 *  modify and/ or redistribute the software under the terms of the CeCILL
 *  license as circulated by CEA, CNRS and INRIA at the following URL
 *  "http://www.cecill.info". 
 * 
 *  As a counterpart to the access to the source code and  rights to copy,
 *  modify and redistribute granted by the license, users are provided only
 *  with a limited warranty  and the software's author,  the holder of the
 *  economic rights,  and the successive licensors  have only  limited
 *  liability. 

 *  In this respect, the user's attention is drawn to the risks associated
 *  with loading,  using,  modifying and/or developing or reproducing the
 *  software by the user in light of its specific status of free software,
 *  that may mean  that it is complicated to manipulate,  and  that  also
 *  therefore means  that it is reserved for developers  and  experienced
 *  professionals having in-depth computer knowledge. Users are therefore
 *  encouraged to load and test the software's suitability as regards their
 *  requirements in conditions enabling the security of their systems and/or 
 *  data to be ensured and,  more generally, to use and operate it in the 
 *  same conditions as regards security. 
 * 
 *  The fact that you are presently reading this means that you have had
 *  knowledge of the CeCILL license and that you accept its terms.
 */
package slib.graph.io.plotter;

import java.util.HashMap;
import java.util.Set;
import org.openrdf.model.URI;
import org.openrdf.model.vocabulary.RDFS;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import slib.indexer.IndexHash;
import slib.graph.model.graph.G;
import slib.graph.model.graph.elements.E;
import slib.graph.model.repo.URIFactory;

/**
 * Class used to plot graph using Graphviz.
 *
 * @author Sébastien Harispe 
 *
 */
public class GraphPlotter_Graphviz {

    static Logger logger = LoggerFactory.getLogger(GraphPlotter_Graphviz.class);

    /**
     *
     * @param factory
     * @param graph
     * @param VertexUriColored
     * @param showLabels
     * @return a DOT String representation of the graph.
     */
    public static String plot(URIFactory factory, G graph, Set VertexUriColored, boolean showLabels) {
        return plot(factory, graph, VertexUriColored, showLabels, true, null);
    }

    /**
     *
     * @param factory
     * @param graph
     * @param VertexColored
     * @param showLabels
     * @param index
     * @return a DOT String representation of the graph
     */
    public static String plot(URIFactory factory, G graph, Set VertexColored, boolean showLabels, boolean showSubSlassOfLabels, IndexHash index) {

        logger.debug("Plot: " + graph.getURI());
        logger.debug("prefixes: " + factory.getURIPrefixes());

        HashMap relColor = new HashMap();

        relColor.put(RDFS.SUBCLASSOF, "black");

        String defColor_v = "\"white\"";//"\"#6583DC\""; // added node  blue
        String defColor_q_v = "\"#FAAB9F\""; // query node  white
        String defColor_e = "black"; // query node  white

        String style = "\n\trankdir=BT;\n\tnode [style=filled,shape=rect]\n\n";

        String out = "digraph plottedgraph {\n";
        out += style;

        String color;

        for (URI uri : graph.getV()) {

            color = defColor_v;

            if (VertexColored != null && VertexColored.contains(uri)) {
                color = defColor_q_v;
            }

            if (index != null && index.containsDescriptionFor(uri)) {

                String indexVal = index.getDescription(uri).getPreferredDescription() + " [" + factory.shortURIasString(uri) + "]";

                String splittedLabel = splitString(indexVal, 20);
                out += "\t\"" + splittedLabel + "\"[fillcolor=" + color + "];\n";

            } else {
                out += "\t\"" + factory.shortURIasString(uri) + "\"[color=" + color + "];\n";
            }
        }

        for (E e : graph.getE()) {

            URI predicate = e.getURI();

            color = defColor_e;

            if (relColor.containsKey(predicate)) {
                color = relColor.get(predicate);
            }

            String info = "";

            if (showLabels && !(showSubSlassOfLabels == false && predicate.equals(RDFS.SUBCLASSOF))) {

                String predicateLabel = factory.shortURIasString(predicate);
                if (index != null && index.containsDescriptionFor(predicate)) {
                    predicateLabel = index.getDescription(predicate).getPreferredDescription();
                }

                info = "[label=\"" + predicateLabel + "\",color=" + color + "]";
            }

            URI s = e.getSource();
            URI t = e.getTarget();

            String source = factory.shortURIasString(s);
            String target = factory.shortURIasString(t);

            if (index != null) {

                if (index.containsDescriptionFor(s)) {
                    source = splitString(index.getDescription(s).getPreferredDescription() + " [" + factory.shortURIasString(s) + "]", 20);
                }
                if (index.containsDescriptionFor(e.getTarget())) {
                    target = splitString(index.getDescription(t).getPreferredDescription() + " [" + factory.shortURIasString(t) + "]", 20);
                }
            }
            out += "\t\"" + source + "\" -> \"" + target + "\" " + info + ";\n";
        }
        out += "}\n";

        return out;
    }

    /**
     *
     * @param in
     * @param max_num_per_string
     * @return a String associated to the String which has been processed.
     */
    public static String splitString(String in, int max_num_per_string) {

        String[] data = in.split(" ");
        String newLabel = "";
        int curLineLength = 0;

        for (String d : data) {



            if (curLineLength + d.length() + 1 <= max_num_per_string) {
                newLabel += d + " ";
                curLineLength += d.length() + 1;
            } else if (curLineLength == 0 && d.length() > max_num_per_string) {
                newLabel += d + "\\n";
                curLineLength = 0;
            } else if (curLineLength + d.length() + 1 > max_num_per_string) {
                newLabel += "\\n" + d + " ";
                curLineLength = d.length() + 1;
            } else if (curLineLength + d.length() + 1 > max_num_per_string) {
                newLabel += "\\n" + d + " ";
                curLineLength = d.length() + 1;
            } else if (curLineLength + d.length() + 1 > max_num_per_string) {
                newLabel += "\\n" + d + " ";
                curLineLength = d.length() + 1;
            }

        }
        return newLabel;

    }
}