Update visualizer builder

10 files changed, 223 insertions, 62 deletions

diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java
index 1329480c..008b2dab 100644
--- a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/internal/DesignSpaceExplorationAdapterImpl.java
@@ -96,6 +96,9 @@ public class DesignSpaceExplorationAdapterImpl implements DesignSpaceExploration
                 trajectory.add(state);
                 strategy.initStrategy(this);
                 strategy.explore();
+                if (isVisualizationEnabled) {
+                        modelVisualizerAdapter.visualize();
+                }
                 return solutions;
         }
 
@@ -247,7 +250,7 @@ public class DesignSpaceExplorationAdapterImpl implements DesignSpaceExploration
                 isNewState = !statesAndTraversedActivations.containsKey(newState);
                 if (isVisualizationEnabled) {
                         if (isNewState) {
-                                modelVisualizerAdapter.addState(newState);
+                                modelVisualizerAdapter.addState(newState, getFitness().values());
                         }
                         // TODO: Change to this:
                         modelVisualizerAdapter.addTransition(previousState, newState, activation.transformationRule().getName(),
@@ -272,11 +275,6 @@ public class DesignSpaceExplorationAdapterImpl implements DesignSpaceExploration
                 fireActivation(activationId);
         }
 
-        @Override
-        public boolean isCurrentInTrajectory() {
-                return trajectory.contains(model.getState());
-        }
-
         public List<Activation> getAllActivations() {
                 List<Activation> result = new LinkedList<>();
                 for (var rule : transformationRules) {
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/objectives/AlwaysSatisfiedRandomHardObjective.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/objectives/AlwaysSatisfiedRandomHardObjective.java
new file mode 100644
index 00000000..327d5e2f
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/objectives/AlwaysSatisfiedRandomHardObjective.java
@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (c) 2010-2016, Andras Szabolcs Nagy, Zoltan Ujhelyi and Daniel Varro
+ * Copyright (c) 2023 The Refinery Authors <https://refinery.tools/>
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-v20.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+package tools.refinery.store.dse.objectives;
+
+import tools.refinery.store.dse.DesignSpaceExplorationAdapter;
+
+import java.util.Random;
+
+/**
+ * This hard objective is fulfilled in any circumstances. Use it if all states should be regarded as a valid solution.
+ *
+ * @author Andras Szabolcs Nagy
+ *
+ */
+public class AlwaysSatisfiedRandomHardObjective extends BaseObjective {
+
+        private static final String DEFAULT_NAME = "AlwaysSatisfiedDummyHardObjective";
+        private static final Random random = new Random(0);
+
+        public AlwaysSatisfiedRandomHardObjective() {
+                super(DEFAULT_NAME);
+        }
+
+        public AlwaysSatisfiedRandomHardObjective(String name) {
+                super(name);
+        }
+
+        @Override
+        public Double getFitness(DesignSpaceExplorationAdapter context) {
+//              return 0d;
+                return random.nextDouble();
+        }
+
+        @Override
+        public boolean isHardObjective() {
+                return true;
+        }
+
+        @Override
+        public boolean satisfiesHardObjective(Double fitness) {
+                return true;
+        }
+
+        @Override
+        public Objective createNew() {
+                return this;
+        }
+
+}
diff --git a/subprojects/store-dse/src/test/java/tools/refinery/store/dse/CRAExamplesTest.java b/subprojects/store-dse/src/test/java/tools/refinery/store/dse/CRAExamplesTest.java
index f1e90280..23f0e703 100644
--- a/subprojects/store-dse/src/test/java/tools/refinery/store/dse/CRAExamplesTest.java
+++ b/subprojects/store-dse/src/test/java/tools/refinery/store/dse/CRAExamplesTest.java
@@ -188,7 +188,13 @@ class CRAExamplesTest {
                                                 .queries(feature, assignFeaturePreconditionHelper, assignFeaturePrecondition,
                                                                 deleteEmptyClassPrecondition, createClassPreconditionHelper, createClassPrecondition,
                                                                 moveFeaturePrecondition))
-                                .with(ModelVisualizerAdapter.builder())
+                                .with(ModelVisualizerAdapter.builder()
+                                                .withOutputpath("test_output")
+                                                .withFormat(FileFormat.DOT)
+                                                .withFormat(FileFormat.SVG)
+                                                .saveStates()
+                                                .saveDesignSpace()
+                                )
                                 .with(DesignSpaceExplorationAdapter.builder()
                                                 .transformations(assignFeatureRule, deleteEmptyClassRule, createClassRule, moveFeatureRule)
 //                                              .strategy(new DepthFirstStrategy(3).continueIfHardObjectivesFulfilled()
@@ -271,9 +277,6 @@ class CRAExamplesTest {
 
                 var states = dseAdapter.explore();
                 System.out.println("states size: " + states.size());
-                System.out.println("states: " + states);
-                var visualizer = model.getAdapter(ModelVisualizerAdapter.class);
-                visualizer.renderDesignSpace("test_output", FileFormat.SVG);
         }
 
 }
diff --git a/subprojects/store-dse/src/test/java/tools/refinery/store/dse/DebugTest.java b/subprojects/store-dse/src/test/java/tools/refinery/store/dse/DebugTest.java
index 553510c8..88c4f152 100644
--- a/subprojects/store-dse/src/test/java/tools/refinery/store/dse/DebugTest.java
+++ b/subprojects/store-dse/src/test/java/tools/refinery/store/dse/DebugTest.java
@@ -90,7 +90,13 @@ class DebugTest {
                                 .symbols(classModel, classElement, feature, isEncapsulatedBy, encapsulates, classes, features)
                                 .with(ViatraModelQueryAdapter.builder()
                                                 .queries(createClassPrecondition, createFeaturePrecondition))
-                                .with(ModelVisualizerAdapter.builder())
+                                .with(ModelVisualizerAdapter.builder()
+                                                .withOutputpath("test_output")
+                                                .withFormat(FileFormat.DOT)
+                                                .withFormat(FileFormat.SVG)
+                                                .saveStates()
+                                                .saveDesignSpace()
+                                )
                                 .with(DesignSpaceExplorationAdapter.builder()
                                                 .transformations(createClassRule, createFeatureRule)
                                                 .strategy(new DepthFirstStrategy(4).continueIfHardObjectivesFulfilled()
@@ -113,10 +119,7 @@ class DebugTest {
 
 
                 var states = dseAdapter.explore();
-                var visualizer = model.getAdapter(ModelVisualizerAdapter.class);
-                visualizer.renderDesignSpace("test_output", FileFormat.SVG);
                 System.out.println("states size: " + states.size());
-                System.out.println("states: " + states);
 
         }
 }
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 bc32323d..ae87d8ac 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerAdapter.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerAdapter.java
@@ -8,9 +8,10 @@ package tools.refinery.visualization;
 import tools.refinery.store.adapter.ModelAdapter;
 import tools.refinery.store.map.Version;
 import tools.refinery.store.tuple.Tuple;
-import tools.refinery.visualization.internal.FileFormat;
 import tools.refinery.visualization.internal.ModelVisualizerBuilderImpl;
 
+import java.util.Collection;
+
 public interface ModelVisualizerAdapter extends ModelAdapter {
 
         ModelVisualizerStoreAdapter getStoreAdapter();
@@ -18,27 +19,14 @@ public interface ModelVisualizerAdapter extends ModelAdapter {
                 return new ModelVisualizerBuilderImpl();
         }
 
-        public String createDotForCurrentModelState();
-
-        public String createDotForModelState(Version version);
-
-        public boolean saveDot(String dot, String filePath);
-
-        public boolean renderDot(String dot, String filePath);
-
-        public boolean renderDot(String dot, FileFormat format, String filePath);
-
         public void addTransition(Version from, Version to, String action);
 
 
         public void addTransition(Version from, Version to, String action, Tuple  activation);
         public void addState(Version state);
+        public void addState(Version state, Collection<Double> fitness);
+        public void addState(Version state, String label);
         public void addSolution(Version state);
-
-        public boolean saveDesignSpace(String path);
-
-        public boolean renderDesignSpace(String path);
-
-        public boolean renderDesignSpace(String path, FileFormat format);
+        public void visualize();
 
 }
diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerBuilder.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerBuilder.java
index 56cc425e..592f5fcf 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerBuilder.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerBuilder.java
@@ -6,6 +6,11 @@
 package tools.refinery.visualization;
 
 import tools.refinery.store.adapter.ModelAdapterBuilder;
+import tools.refinery.visualization.internal.FileFormat;
 
 public interface ModelVisualizerBuilder extends ModelAdapterBuilder {
+        ModelVisualizerBuilder withOutputpath(String outputpath);
+        ModelVisualizerBuilder withFormat(FileFormat format);
+        ModelVisualizerBuilder saveDesignSpace();
+        ModelVisualizerBuilder saveStates();
 }
diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerStoreAdapter.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerStoreAdapter.java
index 6e6453fd..46663b2a 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerStoreAdapter.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/ModelVisualizerStoreAdapter.java
@@ -6,6 +6,17 @@
 package tools.refinery.visualization;
 
 import tools.refinery.store.adapter.ModelStoreAdapter;
+import tools.refinery.visualization.internal.FileFormat;
+
+import java.util.Set;
 
 public interface ModelVisualizerStoreAdapter extends ModelStoreAdapter {
+
+        String getOutputPath();
+
+        boolean isRenderDesignSpace();
+
+        boolean isRenderStates();
+
+        Set<FileFormat> getFormats();
 }
diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizeStoreAdapterImpl.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizeStoreAdapterImpl.java
index b4db2682..04be22d6 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizeStoreAdapterImpl.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizeStoreAdapterImpl.java
@@ -10,11 +10,22 @@ import tools.refinery.store.model.Model;
 import tools.refinery.store.model.ModelStore;
 import tools.refinery.visualization.ModelVisualizerStoreAdapter;
 
+import java.util.Set;
+
 public class ModelVisualizeStoreAdapterImpl implements ModelVisualizerStoreAdapter {
         private final ModelStore store;
+        private final String outputPath;
+        private final boolean renderDesignSpace;
+        private final boolean renderStates;
+        private final Set<FileFormat> formats;
 
-        public ModelVisualizeStoreAdapterImpl(ModelStore store) {
+        public ModelVisualizeStoreAdapterImpl(ModelStore store, String outputPath, Set<FileFormat> formats,
+                                                                                  boolean renderDesignSpace, boolean renderStates) {
                 this.store = store;
+                this.outputPath = outputPath;
+                this.formats = formats;
+                this.renderDesignSpace = renderDesignSpace;
+                this.renderStates = renderStates;
         }
 
         @Override
@@ -26,4 +37,24 @@ public class ModelVisualizeStoreAdapterImpl implements ModelVisualizerStoreAdapt
         public ModelAdapter createModelAdapter(Model model) {
                 return new ModelVisualizerAdapterImpl(model, this);
         }
+
+        @Override
+        public String getOutputPath() {
+                return outputPath;
+        }
+
+        @Override
+        public boolean isRenderDesignSpace() {
+                return renderDesignSpace;
+        }
+
+        @Override
+        public boolean isRenderStates() {
+                return renderStates;
+        }
+
+        @Override
+        public Set<FileFormat> getFormats() {
+                return formats;
+        }
 }
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 efafe5a2..531969b4 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
@@ -26,6 +26,11 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
         private final Map<Version, Integer> states = new HashMap<>();
         private int transitionCounter = 0;
         private Integer numberOfStates = 0;
+        private final String outputPath;
+        private final Set<FileFormat> formats;
+        private final boolean renderDesignSpace;
+        private final boolean renderStates;
+
         private static final Map<Object, String> truthValueToDot = Map.of(
                         TruthValue.TRUE, "1",
                         TruthValue.FALSE, "0",
@@ -38,6 +43,14 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
         public ModelVisualizerAdapterImpl(Model model, ModelVisualizerStoreAdapter storeAdapter) {
                 this.model = model;
                 this.storeAdapter = storeAdapter;
+                this.outputPath = storeAdapter.getOutputPath();
+                this.formats = storeAdapter.getFormats();
+                if (formats.isEmpty()) {
+                        formats.add(FileFormat.SVG);
+                }
+                this.renderDesignSpace = storeAdapter.isRenderDesignSpace();
+                this.renderStates = storeAdapter.isRenderStates();
+
                 this.allInterpretations = new HashMap<>();
                 for (var symbol : storeAdapter.getStore().getSymbols()) {
                         var arity = symbol.arity();
@@ -68,8 +81,7 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                 return storeAdapter;
         }
 
-        @Override
-        public String createDotForCurrentModelState() {
+        private String createDotForCurrentModelState() {
 
                 var unaryTupleToInterpretationsMap = new HashMap<Tuple, LinkedHashSet<Interpretation<?>>>();
 
@@ -229,8 +241,7 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                 };
         }
 
-        @Override
-        public String createDotForModelState(Version version) {
+        private String createDotForModelState(Version version) {
                 var currentVersion = model.getState();
                 model.restore(version);
                 var graph = createDotForCurrentModelState();
@@ -238,8 +249,7 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                 return graph;
         }
 
-        @Override
-        public boolean saveDot(String dot, String filePath) {
+        private boolean saveDot(String dot, String filePath) {
                 File file = new File(filePath);
                 file.getParentFile().mkdirs();
 
@@ -252,13 +262,11 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                 return true;
         }
 
-        @Override
-        public boolean renderDot(String dot, String filePath) {
+        private boolean renderDot(String dot, String filePath) {
                 return renderDot(dot, FileFormat.SVG, filePath);
         }
 
-        @Override
-        public boolean renderDot(String dot, FileFormat format, String filePath) {
+        private boolean renderDot(String dot, FileFormat format, String filePath) {
                 try {
                         Process process = new ProcessBuilder("dot", "-T" + format.getFormat(), "-o", filePath).start();
 
@@ -305,15 +313,21 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
 
         @Override
         public void addState(Version state, Collection<Double> fitness) {
+                var labelBuilder = new StringBuilder();
+                for (var f : fitness) {
+                        labelBuilder.append(f).append(", ");
+                }
+                addState(state, labelBuilder.toString());
+        }
+
+        @Override
+        public void addState(Version state, String label) {
                 if (states.containsKey(state)) {
                         return;
                 }
                 states.put(state, numberOfStates++);
                 designSpaceBuilder.append(states.get(state)).append(" [label = \"").append(states.get(state)).append(" (");
-
-                for (var f : fitness) {
-                        designSpaceBuilder.append(f).append(", ");
-                }
+                designSpaceBuilder.append(label);
                 designSpaceBuilder.append(")\"\n").append("URL=\"./").append(states.get(state)).append(".svg\"]\n");
         }
 
@@ -328,8 +342,7 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                 return designSpaceBuilder.toString();
         }
 
-        @Override
-        public boolean saveDesignSpace(String path) {
+        private boolean saveDesignSpace(String path) {
                 saveDot(buildDesignSpaceDot(), path + "/designSpace.dot");
                 for (var entry : states.entrySet()) {
                         saveDot(createDotForModelState(entry.getKey()), path + "/" + entry.getValue() + ".dot");
@@ -337,21 +350,38 @@ public class ModelVisualizerAdapterImpl implements ModelVisualizerAdapter {
                 return true;
         }
 
-        @Override
-        public boolean renderDesignSpace(String path) {
-                return renderDesignSpace(path, FileFormat.SVG);
+        private void renderDesignSpace(String path, Set<FileFormat> formats) {
+                File filePath = new File(path);
+                filePath.mkdirs();
+                if (renderStates) {
+                        for (var entry : states.entrySet()) {
+                                var stateId = entry.getValue();
+                                var stateDot = createDotForModelState(entry.getKey());
+                                for (var format : formats) {
+                                        if (format == FileFormat.DOT) {
+                                                saveDot(stateDot, path + "/" + stateId + ".dot");
+                                        }
+                                        else {
+                                                renderDot(stateDot, format, path + "/" + stateId + "." + format.getFormat());
+                                        }
+                                }
+                        }
+                }
+                if (renderDesignSpace) {
+                        var designSpaceDot = buildDesignSpaceDot();
+                        for (var format : formats) {
+                                if (format == FileFormat.DOT) {
+                                        saveDot(designSpaceDot, path + "/designSpace.dot");
+                                }
+                                else {
+                                        renderDot(designSpaceDot, format, path + "/designSpace." + format.getFormat());
+                                }
+                        }
+                }
         }
 
         @Override
-        public boolean renderDesignSpace(String path, FileFormat format) {
-//              for (var entry : states.entrySet()) {
-//                      var stateId = entry.getValue();
-//                      var stateDot = createDotForModelState(entry.getKey());
-//                      saveDot(stateDot, path + "/" + stateId + ".dot");
-//                      renderDot(stateDot, format, path + "/" + stateId + "." + format.getFormat());
-//              }
-                var designSpaceDot = buildDesignSpaceDot();
-                saveDot(designSpaceDot, path + "/designSpace.dot");
-                return renderDot(designSpaceDot, format, path + "/designSpace." + format.getFormat());
+        public void visualize() {
+                renderDesignSpace(outputPath, formats);
         }
 }
diff --git a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerBuilderImpl.java b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerBuilderImpl.java
index d19cf2cf..e4d801d8 100644
--- a/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerBuilderImpl.java
+++ b/subprojects/visualization/src/main/java/tools/refinery/visualization/internal/ModelVisualizerBuilderImpl.java
@@ -9,11 +9,47 @@ import tools.refinery.store.adapter.AbstractModelAdapterBuilder;
 import tools.refinery.store.model.ModelStore;
 import tools.refinery.visualization.ModelVisualizerBuilder;
 
+import java.util.LinkedHashSet;
+import java.util.Set;
+
 public class ModelVisualizerBuilderImpl
                 extends AbstractModelAdapterBuilder<ModelVisualizeStoreAdapterImpl>
                 implements ModelVisualizerBuilder {
+        private String outputPath;
+        private boolean saveDesignSpace = false;
+        private boolean saveStates = false;
+        private Set<FileFormat> formats = new LinkedHashSet<>();
+
         @Override
         protected ModelVisualizeStoreAdapterImpl doBuild(ModelStore store) {
-                return new ModelVisualizeStoreAdapterImpl(store);
+                return new ModelVisualizeStoreAdapterImpl(store, outputPath, formats, saveDesignSpace, saveStates);
+        }
+
+        @Override
+        public ModelVisualizerBuilder withOutputpath(String outputpath) {
+                checkNotConfigured();
+                this.outputPath = outputpath;
+                return this;
+        }
+
+        @Override
+        public ModelVisualizerBuilder withFormat(FileFormat format) {
+                checkNotConfigured();
+                this.formats.add(format);
+                return this;
+        }
+
+        @Override
+        public ModelVisualizerBuilder saveDesignSpace() {
+                checkNotConfigured();
+                this.saveDesignSpace = true;
+                return this;
+        }
+
+        @Override
+        public ModelVisualizerBuilder saveStates() {
+                checkNotConfigured();
+                this.saveStates = true;
+                return this;
         }
 }