Add visualization using DOT language

3 files changed, 132 insertions, 13 deletions

diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerAdapter.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerAdapter.java
index ae23e3bc..42f01242 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerAdapter.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerAdapter.java
@@ -3,6 +3,7 @@ package tools.refinery.visualization;
 import guru.nidi.graphviz.engine.Format;
 import guru.nidi.graphviz.model.MutableGraph;
 import tools.refinery.store.adapter.ModelAdapter;
+import tools.refinery.visualization.internal.FileFormat;
 import tools.refinery.visualization.internal.ModelVisualizerBuilderImpl;
 
 public interface ModelVisualizerAdapter extends ModelAdapter {
@@ -16,7 +17,17 @@ public interface ModelVisualizerAdapter extends ModelAdapter {
 
         public MutableGraph createVisualizationForModelState(Long version);
 
+        public String createDotForCurrentModelState();
+
+        public String createDotForModelState(Long version);
+
         public boolean saveVisualization(MutableGraph graph, String path);
 
         public boolean saveVisualization(MutableGraph graph, Format format, String path);
+
+        public boolean saveDot(String dot, String filePath);
+
+        public boolean renderDot(String dot, String filePath);
+
+        public boolean renderDot(String dot, FileFormat format, String filePath);
 }
diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/FileFormat.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/FileFormat.java
new file mode 100644
index 00000000..43d6eb3f
--- /dev/null
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/FileFormat.java
@@ -0,0 +1,21 @@
+package tools.refinery.visualization.internal;
+
+public enum FileFormat {
+        BMP("bmp"),
+        DOT("dot"),
+        JPEG("jpg"),
+        PDF("pdf"),
+        PLAIN("plain"),
+        PNG("png"),
+        SVG("svg");
+
+        private final String format;
+
+        FileFormat(String format) {
+                this.format = format;
+        }
+
+        public String getFormat() {
+                return format;
+        }
+}
diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerAdapterImpl.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerAdapterImpl.java
index 475ae416..7456d913 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerAdapterImpl.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerAdapterImpl.java
@@ -1,24 +1,51 @@
 package tools.refinery.visualization.internal;
 
+import guru.nidi.graphviz.attribute.GraphAttr;
 import guru.nidi.graphviz.attribute.Label;
 import guru.nidi.graphviz.engine.Format;
 import guru.nidi.graphviz.engine.Graphviz;
 import guru.nidi.graphviz.model.MutableGraph;
+import tools.refinery.store.model.Interpretation;
 import tools.refinery.store.model.Model;
+import tools.refinery.store.representation.AnySymbol;
+import tools.refinery.store.representation.TruthValue;
 import tools.refinery.visualization.ModelVisualizerAdapter;
 import tools.refinery.visualization.ModelVisualizerStoreAdapter;
 
-import java.io.File;
-import java.io.IOException;
+import java.io.*;
+import java.util.HashMap;
+import java.util.Map;
 
 import static guru.nidi.graphviz.model.Factory.*;
 
 public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
         private final Model model;
         private final ModelVisualizerStoreAdapter storeAdapter;
+        private final Map<AnySymbol, Interpretation<?>> interpretations;
         public ModelVisualizerAdapterImpl(Model model, ModelVisualizerStoreAdapter storeAdapter) {
                 this.model = model;
                 this.storeAdapter = storeAdapter;
+                this.interpretations = new HashMap<>();
+                for (var symbol : storeAdapter.getStore().getSymbols()) {
+                        var arity = symbol.arity();
+                        if (arity < 1 || arity > 2) {
+                                continue;
+                        }
+                        var interpretation = model.getInterpretation(symbol);
+                        var valueType = symbol.valueType();
+                        Interpretation<?> castInterpretation;
+                        if (valueType == Boolean.class) {
+                                castInterpretation = (Interpretation<Boolean>) interpretation;
+                        }
+                        // TODO: support TruthValue
+//                      else if (valueType == TruthValue.class) {
+//                              castInterpretation = (Interpretation<TruthValue>) interpretation;
+//                      }
+                        else {
+                                continue;
+                        }
+                        interpretations.put(symbol, castInterpretation);
+                }
         }
 
         @Override
@@ -33,19 +60,10 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
 
         @Override
         public MutableGraph createVisualizationForCurrentModelState() {
-                var interpretations = model.getInterpretations();
-                MutableGraph graph = mutGraph("model").setDirected(true);
+                var graph = mutGraph("model").setDirected(true).graphAttrs().add(GraphAttr.dpi(100));
                 for (var entry : interpretations.entrySet()) {
                         var key = entry.getKey();
                         var arity = key.arity();
-                        if (arity < 1 || arity > 2) {
-                                continue;
-                        }
-                        var valueType = key.valueType();
-                        // TODO: support TruthValue
-                        if (valueType != Boolean.class) {
-                                continue;
-                        }
                         var cursor = entry.getValue().getAll();
                         while (cursor.move()) {
                                 if (arity == 1) {
@@ -65,7 +83,41 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
         public MutableGraph createVisualizationForModelState(Long version) {
                 var currentVersion = model.getState();
                 model.restore(version);
-                MutableGraph graph = createVisualizationForCurrentModelState();
+                var graph = createVisualizationForCurrentModelState();
+                model.restore(currentVersion);
+                return graph;
+        }
+
+        @Override
+        public String createDotForCurrentModelState() {
+                var sb = new StringBuilder();
+                sb.append("digraph model {\n");
+                for (var entry : interpretations.entrySet()) {
+                        var key = entry.getKey();
+                        var arity = key.arity();
+                        var cursor = entry.getValue().getAll();
+                        while (cursor.move()) {
+                                if (arity == 1) {
+                                        var id = cursor.getKey().get(0);
+                                        sb.append("\t").append(id).append(" [label=\"").append(key.name()).append(": ").append(id)
+                                                        .append("\"]\n");
+                                } else {
+                                        var from = cursor.getKey().get(0);
+                                        var to = cursor.getKey().get(1);
+                                        sb.append("\t").append(from).append(" -> ").append(to).append(" [label=\"").append(key.name())
+                                                        .append("\"]\n");
+                                }
+                        }
+                }
+                sb.append("}");
+                return sb.toString();
+        }
+
+        @Override
+        public String createDotForModelState(Long version) {
+                var currentVersion = model.getState();
+                model.restore(version);
+                var graph = createDotForCurrentModelState();
                 model.restore(currentVersion);
                 return graph;
         }
@@ -85,4 +137,39 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                         return false;
                 }
         }
+
+        @Override
+        public boolean saveDot(String dot, String filePath) {
+                File file = new File(filePath);
+                file.getParentFile().mkdirs();
+
+                try (FileWriter writer = new FileWriter(file)) {
+                        writer.write(dot);
+                } catch (Exception e) {
+                        e.printStackTrace();
+                        return false;
+                }
+                return true;
+        }
+
+        @Override
+        public boolean renderDot(String dot, String filePath) {
+                return renderDot(dot, FileFormat.SVG, filePath);
+        }
+
+        @Override
+        public boolean renderDot(String dot, FileFormat format, String filePath) {
+                try {
+                        Process process = new ProcessBuilder("dot", "-T" + format.getFormat(), "-o", filePath).start();
+
+                        OutputStream osToProcess = process.getOutputStream();
+                        PrintWriter pwToProcess = new PrintWriter(osToProcess);
+                        pwToProcess.write(dot);
+                        pwToProcess.close();
+                } catch (IOException e) {
+                        e.printStackTrace();
+                        return false;
+                }
+                return true;
+        }
 }