12 files changed, 407 insertions, 0 deletions

diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/BoundPropagator.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/BoundPropagator.java
new file mode 100644
index 00000000..5ad61463
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/BoundPropagator.java
@@ -0,0 +1,11 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation;
+
+@FunctionalInterface
+public interface BoundPropagator {
+        PropagationResult propagateOne();
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationAdapter.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationAdapter.java
new file mode 100644
index 00000000..3ea5a75f
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationAdapter.java
@@ -0,0 +1,20 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation;
+
+import tools.refinery.store.adapter.ModelAdapter;
+import tools.refinery.store.dse.propagation.impl.PropagationBuilderImpl;
+
+public interface PropagationAdapter extends ModelAdapter {
+        @Override
+        PropagationStoreAdapter getStoreAdapter();
+
+        PropagationResult propagate();
+
+        static PropagationBuilder builder() {
+                return new PropagationBuilderImpl();
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationBuilder.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationBuilder.java
new file mode 100644
index 00000000..f8a89b30
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationBuilder.java
@@ -0,0 +1,32 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation;
+
+import tools.refinery.store.adapter.ModelAdapterBuilder;
+import tools.refinery.store.dse.transition.Rule;
+import tools.refinery.store.model.ModelStore;
+
+import java.util.Collection;
+import java.util.List;
+
+@SuppressWarnings("UnusedReturnValue")
+public interface PropagationBuilder extends ModelAdapterBuilder {
+        PropagationBuilder rule(Rule propagationRule);
+
+        default PropagationBuilder rules(Rule... propagationRules) {
+                return rules(List.of(propagationRules));
+        }
+
+        default PropagationBuilder rules(Collection<Rule> propagationRules) {
+                propagationRules.forEach(this::rule);
+                return this;
+        }
+
+        PropagationBuilder propagator(Propagator propagator);
+
+        @Override
+        PropagationStoreAdapter build(ModelStore store);
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationResult.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationResult.java
new file mode 100644
index 00000000..ea56653a
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationResult.java
@@ -0,0 +1,28 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation;
+
+public enum PropagationResult {
+        UNCHANGED,
+        PROPAGATED,
+        REJECTED;
+
+        public PropagationResult andThen(PropagationResult next) {
+                return switch (this) {
+                        case UNCHANGED -> next;
+                        case PROPAGATED -> next == REJECTED ? REJECTED : PROPAGATED;
+                        case REJECTED -> REJECTED;
+                };
+        }
+
+        public boolean isRejected() {
+                return this == REJECTED;
+        }
+
+        public boolean isChanged() {
+                return this == PROPAGATED;
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationStoreAdapter.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationStoreAdapter.java
new file mode 100644
index 00000000..82cba909
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/PropagationStoreAdapter.java
@@ -0,0 +1,14 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation;
+
+import tools.refinery.store.adapter.ModelStoreAdapter;
+import tools.refinery.store.model.Model;
+
+public interface PropagationStoreAdapter extends ModelStoreAdapter {
+        @Override
+        PropagationAdapter createModelAdapter(Model model);
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/Propagator.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/Propagator.java
new file mode 100644
index 00000000..c6b4e1c9
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/Propagator.java
@@ -0,0 +1,17 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation;
+
+import tools.refinery.store.model.Model;
+import tools.refinery.store.model.ModelStoreBuilder;
+
+@FunctionalInterface
+public interface Propagator {
+        default void configure(ModelStoreBuilder storeBuilder) {
+        }
+
+        BoundPropagator bindToModel(Model model);
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationAdapterImpl.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationAdapterImpl.java
new file mode 100644
index 00000000..fdd19217
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationAdapterImpl.java
@@ -0,0 +1,75 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation.impl;
+
+import tools.refinery.store.dse.propagation.BoundPropagator;
+import tools.refinery.store.dse.propagation.PropagationAdapter;
+import tools.refinery.store.dse.propagation.PropagationResult;
+import tools.refinery.store.dse.propagation.PropagationStoreAdapter;
+import tools.refinery.store.model.Model;
+
+class PropagationAdapterImpl implements PropagationAdapter {
+        private final Model model;
+        private final PropagationStoreAdapterImpl storeAdapter;
+        private final BoundPropagator[] boundPropagators;
+
+        public PropagationAdapterImpl(Model model, PropagationStoreAdapterImpl storeAdapter) {
+                this.model = model;
+                this.storeAdapter = storeAdapter;
+                var propagators = storeAdapter.getPropagators();
+                boundPropagators = new BoundPropagator[propagators.size()];
+                for (int i = 0; i < boundPropagators.length; i++) {
+                        boundPropagators[i] = propagators.get(i).bindToModel(model);
+                }
+        }
+
+        @Override
+        public PropagationResult propagate() {
+                PropagationResult result = PropagationResult.UNCHANGED;
+                PropagationResult lastResult;
+                do {
+                        model.checkCancelled();
+                        lastResult = propagateOne();
+                        result = result.andThen(lastResult);
+                } while (lastResult.isChanged());
+                return result;
+        }
+
+        private PropagationResult propagateOne() {
+                PropagationResult result = PropagationResult.UNCHANGED;
+                for (int i = 0; i < boundPropagators.length; i++) {
+                        model.checkCancelled();
+                        var lastResult = propagateUntilFixedPoint(i);
+                        result = result.andThen(lastResult);
+                        if (result.isRejected()) {
+                                break;
+                        }
+                }
+                return result;
+        }
+
+        private PropagationResult propagateUntilFixedPoint(int propagatorIndex) {
+                var propagator = boundPropagators[propagatorIndex];
+                PropagationResult result = PropagationResult.UNCHANGED;
+                PropagationResult lastResult;
+                do {
+                        model.checkCancelled();
+                        lastResult = propagator.propagateOne();
+                        result = result.andThen(lastResult);
+                } while (lastResult.isChanged());
+                return result;
+        }
+
+        @Override
+        public Model getModel() {
+                return model;
+        }
+
+        @Override
+        public PropagationStoreAdapter getStoreAdapter() {
+                return storeAdapter;
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationBuilderImpl.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationBuilderImpl.java
new file mode 100644
index 00000000..c844a89f
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationBuilderImpl.java
@@ -0,0 +1,53 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation.impl;
+
+import tools.refinery.store.adapter.AbstractModelAdapterBuilder;
+import tools.refinery.store.dse.propagation.PropagationBuilder;
+import tools.refinery.store.dse.propagation.PropagationStoreAdapter;
+import tools.refinery.store.dse.propagation.Propagator;
+import tools.refinery.store.dse.propagation.impl.rule.RuleBasedPropagator;
+import tools.refinery.store.dse.transition.Rule;
+import tools.refinery.store.model.ModelStore;
+import tools.refinery.store.model.ModelStoreBuilder;
+
+import java.util.*;
+
+public class PropagationBuilderImpl extends AbstractModelAdapterBuilder<PropagationStoreAdapter>
+                implements PropagationBuilder {
+        private final Set<Rule> propagationRules = new LinkedHashSet<>();
+        private final Deque<Propagator> propagators = new ArrayDeque<>();
+
+        @Override
+        public PropagationBuilder rule(Rule propagationRule) {
+                checkNotConfigured();
+                propagationRules.add(propagationRule);
+                return this;
+        }
+
+        @Override
+        public PropagationBuilder propagator(Propagator propagator) {
+                checkNotConfigured();
+                propagators.addFirst(propagator);
+                return this;
+        }
+
+        @Override
+        protected void doConfigure(ModelStoreBuilder storeBuilder) {
+                super.doConfigure(storeBuilder);
+                if (!propagationRules.isEmpty()) {
+                        propagators.addFirst(new RuleBasedPropagator(List.copyOf(propagationRules)));
+                }
+                for (var propagator : propagators) {
+                        propagator.configure(storeBuilder);
+                }
+        }
+
+        @Override
+        protected PropagationStoreAdapter doBuild(ModelStore store) {
+                return new PropagationStoreAdapterImpl(store, List.copyOf(propagators));
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationStoreAdapterImpl.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationStoreAdapterImpl.java
new file mode 100644
index 00000000..a223caed
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/PropagationStoreAdapterImpl.java
@@ -0,0 +1,38 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation.impl;
+
+import tools.refinery.store.dse.propagation.PropagationAdapter;
+import tools.refinery.store.dse.propagation.PropagationStoreAdapter;
+import tools.refinery.store.dse.propagation.Propagator;
+import tools.refinery.store.model.Model;
+import tools.refinery.store.model.ModelStore;
+
+import java.util.List;
+
+class PropagationStoreAdapterImpl implements PropagationStoreAdapter {
+        private final ModelStore store;
+        private final List<Propagator> propagators;
+
+        PropagationStoreAdapterImpl(ModelStore store, List<Propagator> propagators) {
+                this.store = store;
+                this.propagators = propagators;
+        }
+
+        @Override
+        public ModelStore getStore() {
+                return store;
+        }
+
+        @Override
+        public PropagationAdapter createModelAdapter(Model model) {
+                return new PropagationAdapterImpl(model, this);
+        }
+
+        List<Propagator> getPropagators() {
+                return propagators;
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/BoundPropagationRule.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/BoundPropagationRule.java
new file mode 100644
index 00000000..a70292ad
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/BoundPropagationRule.java
@@ -0,0 +1,40 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation.impl.rule;
+
+import tools.refinery.store.dse.propagation.PropagationResult;
+import tools.refinery.store.dse.transition.Rule;
+import tools.refinery.store.dse.transition.actions.BoundAction;
+import tools.refinery.store.model.Model;
+import tools.refinery.store.query.ModelQueryAdapter;
+import tools.refinery.store.query.resultset.ResultSet;
+
+class BoundPropagationRule {
+        private final Model model;
+        private final ResultSet<Boolean> resultSet;
+        private final BoundAction action;
+
+        public BoundPropagationRule(Model model, Rule rule) {
+                this.model = model;
+                resultSet = model.getAdapter(ModelQueryAdapter.class).getResultSet(rule.getPrecondition());
+                action = rule.createAction(model);
+        }
+
+        public PropagationResult fireAll() {
+                if (resultSet.size() == 0) {
+                        return PropagationResult.UNCHANGED;
+                }
+                var cursor = resultSet.getAll();
+                while (cursor.move()) {
+                        model.checkCancelled();
+                        var result = action.fire(cursor.getKey());
+                        if (!result) {
+                                return PropagationResult.REJECTED;
+                        }
+                }
+                return PropagationResult.PROPAGATED;
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/BoundRuleBasedPropagator.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/BoundRuleBasedPropagator.java
new file mode 100644
index 00000000..bd03f923
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/BoundRuleBasedPropagator.java
@@ -0,0 +1,43 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation.impl.rule;
+
+import tools.refinery.store.dse.propagation.BoundPropagator;
+import tools.refinery.store.dse.propagation.PropagationResult;
+import tools.refinery.store.dse.transition.Rule;
+import tools.refinery.store.model.Model;
+import tools.refinery.store.query.ModelQueryAdapter;
+
+import java.util.List;
+
+public class BoundRuleBasedPropagator implements BoundPropagator {
+        private final ModelQueryAdapter queryEngine;
+        private final BoundPropagationRule[] boundRules;
+
+        public BoundRuleBasedPropagator(Model model, List<Rule> propagationRules) {
+                queryEngine = model.getAdapter(ModelQueryAdapter.class);
+                boundRules = new BoundPropagationRule[propagationRules.size()];
+                for (int i = 0; i < boundRules.length; i++) {
+                        boundRules[i] = new BoundPropagationRule(model, propagationRules.get(i));
+                }
+        }
+
+        @Override
+        public PropagationResult propagateOne() {
+                queryEngine.flushChanges();
+                PropagationResult result = PropagationResult.UNCHANGED;
+                // Use a classic for loop to avoid allocating an iterator.
+                //noinspection ForLoopReplaceableByForEach
+                for (int i = 0; i < boundRules.length; i++) {
+                        var lastResult = boundRules[i].fireAll();
+                        result = result.andThen(lastResult);
+                        if (result.isRejected()) {
+                                break;
+                        }
+                }
+                return result;
+        }
+}
diff --git a/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/RuleBasedPropagator.java b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/RuleBasedPropagator.java
new file mode 100644
index 00000000..709b2416
--- /dev/null
+++ b/subprojects/store-dse/src/main/java/tools/refinery/store/dse/propagation/impl/rule/RuleBasedPropagator.java
@@ -0,0 +1,36 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.dse.propagation.impl.rule;
+
+import tools.refinery.store.dse.propagation.BoundPropagator;
+import tools.refinery.store.dse.propagation.Propagator;
+import tools.refinery.store.dse.transition.Rule;
+import tools.refinery.store.model.Model;
+import tools.refinery.store.model.ModelStoreBuilder;
+import tools.refinery.store.query.ModelQueryBuilder;
+
+import java.util.List;
+
+public class RuleBasedPropagator implements Propagator {
+        private final List<Rule> propagationRules;
+
+        public RuleBasedPropagator(List<Rule> propagationRules) {
+                this.propagationRules = propagationRules;
+        }
+
+        @Override
+        public void configure(ModelStoreBuilder storeBuilder) {
+                var queryBuilder = storeBuilder.getAdapter(ModelQueryBuilder.class);
+                for (var propagationRule : propagationRules) {
+                        queryBuilder.query(propagationRule.getPrecondition());
+                }
+        }
+
+        @Override
+        public BoundPropagator bindToModel(Model model) {
+                return new BoundRuleBasedPropagator(model, propagationRules);
+        }
+}