5 files changed, 356 insertions, 0 deletions

diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/Bag.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/Bag.java
new file mode 100644
index 00000000..4aef0f96
--- /dev/null
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/Bag.java
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright (c) 2004-2008 Gabor Bergmann and Daniel Varro
+ * 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.viatra.runtime.rete.misc;
+
+import java.util.Collection;
+import java.util.LinkedList;
+
+import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
+import tools.refinery.viatra.runtime.matchers.util.Direction;
+import tools.refinery.viatra.runtime.rete.network.ReteContainer;
+import tools.refinery.viatra.runtime.rete.network.communication.Timestamp;
+
+/**
+ * @author Gabor Bergmann
+ * 
+ *         A bag is a container that tuples can be dumped into. Does NOT propagate updates! Optimized for small contents
+ *         size OR positive updates only.
+ */
+public class Bag extends SimpleReceiver {
+
+    public Collection<Tuple> contents;
+
+    public Bag(ReteContainer reteContainer) {
+        super(reteContainer);
+        contents = new LinkedList<Tuple>();
+    }
+
+    @Override
+    public void update(Direction direction, Tuple updateElement, Timestamp timestamp) {
+        if (direction == Direction.INSERT)
+            contents.add(updateElement);
+        else
+            contents.remove(updateElement);
+    }
+    
+}
diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/ConstantNode.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/ConstantNode.java
new file mode 100644
index 00000000..980d3eee
--- /dev/null
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/ConstantNode.java
@@ -0,0 +1,50 @@
+/*******************************************************************************
+ * Copyright (c) 2004-2008 Gabor Bergmann and Daniel Varro
+ * 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.viatra.runtime.rete.misc;
+
+import java.util.Collection;
+import java.util.Map;
+
+import tools.refinery.viatra.runtime.matchers.context.IQueryRuntimeContext;
+import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
+import tools.refinery.viatra.runtime.matchers.util.timeline.Timeline;
+import tools.refinery.viatra.runtime.rete.network.ReteContainer;
+import tools.refinery.viatra.runtime.rete.network.StandardNode;
+import tools.refinery.viatra.runtime.rete.network.communication.Timestamp;
+
+/**
+ * Node that always contains a single constant Tuple
+ * 
+ * @author Gabor Bergmann
+ */
+public class ConstantNode extends StandardNode {
+
+    protected Tuple constant;
+
+    /**
+     * @param constant
+     *            will be wrapped using {@link IQueryRuntimeContext#wrapTuple(Tuple)}
+     */
+    public ConstantNode(ReteContainer reteContainer, Tuple constant) {
+        super(reteContainer);
+        this.constant = reteContainer.getNetwork().getEngine().getRuntimeContext().wrapTuple(constant);
+    }
+
+    @Override
+    public void pullInto(Collection<Tuple> collector, boolean flush) {
+        collector.add(constant);
+    }
+
+    @Override
+    public void pullIntoWithTimeline(final Map<Tuple, Timeline<Timestamp>> collector, final boolean flush) {
+        collector.put(constant, Timestamp.INSERT_AT_ZERO_TIMELINE);
+    }
+
+}
diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/DefaultDeltaMonitor.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/DefaultDeltaMonitor.java
new file mode 100644
index 00000000..efba3117
--- /dev/null
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/DefaultDeltaMonitor.java
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright (c) 2004-2010 Gabor Bergmann and Daniel Varro
+ * 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.viatra.runtime.rete.misc;
+
+import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
+import tools.refinery.viatra.runtime.rete.network.Network;
+import tools.refinery.viatra.runtime.rete.network.ReteContainer;
+
+/**
+ * Default configuration for DeltaMonitor.
+ * 
+ * @author Gabor Bergmann
+ * 
+ */
+public class DefaultDeltaMonitor extends DeltaMonitor<Tuple> {
+
+    /**
+     * @param reteContainer
+     */
+    public DefaultDeltaMonitor(ReteContainer reteContainer) {
+        super(reteContainer);
+    }
+
+    /**
+     * @param network
+     */
+    public DefaultDeltaMonitor(Network network) {
+        super(network.getHeadContainer());
+    }
+
+    @Override
+    public Tuple statelessConvert(Tuple tuple) {
+        return tuple;
+    }
+
+}
diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/DeltaMonitor.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/DeltaMonitor.java
new file mode 100644
index 00000000..82b6ecda
--- /dev/null
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/DeltaMonitor.java
@@ -0,0 +1,111 @@
+/*******************************************************************************
+ * Copyright (c) 2004-2008 Gabor Bergmann and Daniel Varro
+ * 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.viatra.runtime.rete.misc;
+
+import java.util.Collection;
+import java.util.LinkedHashSet;
+
+import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
+import tools.refinery.viatra.runtime.matchers.util.Clearable;
+import tools.refinery.viatra.runtime.matchers.util.Direction;
+import tools.refinery.viatra.runtime.rete.network.ReteContainer;
+import tools.refinery.viatra.runtime.rete.network.communication.Timestamp;
+
+/**
+ * A monitoring object that connects to the rete network as a receiver to reflect changes since an arbitrary state
+ * acknowledged by the client. Match tuples are represented by a type MatchType.
+ * 
+ * <p>
+ * <b>Usage</b>. If a new matching is found, it appears in the matchFoundEvents collection, and disappears when that
+ * particular matching cannot be found anymore. If the event of finding a match has been processed by the client, it can
+ * be removed manually. In this case, when a previously found matching is lost, the Tuple will appear in the
+ * matchLostEvents collection, and disappear upon finding the same matching again. "Matching lost" events can also be
+ * acknowledged by removing a Tuple from the collection. If the matching is found once again, it will return to
+ * matchFoundEvents.
+ * 
+ * <p>
+ * <b>Technical notes</b>. Does NOT propagate updates!
+ * 
+ * By overriding statelessConvert(), results can be stored to a MatchType. MatchType must provide equals() and
+ * hashCode() reflecting its contents. The default implementation (DefaultDeltaMonitor) uses Tuple as MatchType.
+ * 
+ * By overriding statelessFilter(), some tuples can be filtered.
+ * 
+ * @author Gabor Bergmann
+ * 
+ */
+public abstract class DeltaMonitor<MatchType> extends SimpleReceiver implements Clearable {
+
+    /**
+     * matches that are newly found
+     */
+    public Collection<MatchType> matchFoundEvents;
+    /**
+     * matches that are newly lost
+     */
+    public Collection<MatchType> matchLostEvents;
+
+    /**
+     * @param reteContainer
+     */
+    public DeltaMonitor(ReteContainer reteContainer) {
+        super(reteContainer);
+        matchFoundEvents = new LinkedHashSet<MatchType>();
+        matchLostEvents = new LinkedHashSet<MatchType>();
+        reteContainer.registerClearable(this);
+    }
+
+    // /**
+    // * Build a delta monitor into the head container of the network.
+    // *
+    // * @param network
+    // */
+    // public DeltaMonitor(Network network) {
+    // this(network.getHeadContainer());
+    // }
+
+    /**
+     * Override this method to provide a lightweight, stateless filter on the tuples
+     * 
+     * @param tuple
+     *            the occurrence that is to be filtered
+     * @return true if this tuple should be monitored, false if ignored
+     */
+    public boolean statelessFilter(Tuple tuple) {
+        return true;
+    }
+
+    public abstract MatchType statelessConvert(Tuple tuple);
+
+    @Override
+    public void update(Direction direction, Tuple updateElement, Timestamp timestamp) {
+        if (statelessFilter(updateElement)) {
+            MatchType match = statelessConvert(updateElement);
+            if (direction == Direction.INSERT) {
+                if (!matchLostEvents.remove(match)) // either had before but
+                                                    // lost
+                    matchFoundEvents.add(match); // or brand-new
+            } else // revoke
+            {
+                if (!matchFoundEvents.remove(match)) // either never found
+                                                     // in the first
+                                                     // place
+                    matchLostEvents.add(match); // or newly lost
+            }
+        }
+    }
+
+    @Override
+    public void clear() {
+        matchFoundEvents.clear();
+        matchLostEvents.clear();
+    }
+
+}
diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/SimpleReceiver.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/SimpleReceiver.java
new file mode 100644
index 00000000..dcf9ae78
--- /dev/null
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/misc/SimpleReceiver.java
@@ -0,0 +1,109 @@
+/*******************************************************************************
+ * Copyright (c) 2010-2012, Bergmann Gabor, Istvan Rath and Daniel Varro
+ * 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.viatra.runtime.rete.misc;
+
+import java.util.Collection;
+import java.util.Collections;
+
+import tools.refinery.viatra.runtime.rete.network.BaseNode;
+import tools.refinery.viatra.runtime.rete.network.Receiver;
+import tools.refinery.viatra.runtime.rete.network.ReteContainer;
+import tools.refinery.viatra.runtime.rete.network.Supplier;
+import tools.refinery.viatra.runtime.rete.network.mailbox.Mailbox;
+import tools.refinery.viatra.runtime.rete.network.mailbox.timeless.BehaviorChangingMailbox;
+import tools.refinery.viatra.runtime.rete.network.mailbox.timely.TimelyMailbox;
+import tools.refinery.viatra.runtime.rete.traceability.TraceInfo;
+
+/**
+ * @author Bergmann Gabor
+ * 
+ */
+public abstract class SimpleReceiver extends BaseNode implements Receiver {
+
+    protected Supplier parent = null;
+    /**
+     * @since 1.6
+     */
+    protected final Mailbox mailbox;
+    
+    /**
+     * @param reteContainer
+     */
+    public SimpleReceiver(ReteContainer reteContainer) {
+        super(reteContainer);
+        mailbox = instantiateMailbox();
+        reteContainer.registerClearable(mailbox);
+    }
+
+    /**
+     * Instantiates the {@link Mailbox} of this receiver.
+     * Subclasses may override this method to provide their own mailbox implementation.
+     * 
+     * @return the mailbox
+     * @since 2.0
+     */
+    protected Mailbox instantiateMailbox() {
+        if (this.reteContainer.isTimelyEvaluation()) {
+            return new TimelyMailbox(this, this.reteContainer);
+        } else {
+            return new BehaviorChangingMailbox(this, this.reteContainer);
+        }
+    }
+    
+    @Override
+    public Mailbox getMailbox() {
+        return this.mailbox;
+    }
+    
+    @Override
+    public void appendParent(Supplier supplier) {
+        if (parent == null)
+            parent = supplier;
+        else
+            throw new UnsupportedOperationException("Illegal RETE edge: " + this + " already has a parent (" + parent
+                    + ") and cannot connect to additional parent (" + supplier
+                    + ") as it is not a Uniqueness Enforcer Node. ");
+    }
+
+    @Override
+    public void removeParent(Supplier supplier) {
+        if (parent == supplier)
+            parent = null;
+        else
+            throw new IllegalArgumentException("Illegal RETE edge removal: the parent of " + this + " is not "
+                    + supplier);
+    }
+
+    @Override
+    public Collection<Supplier> getParents() {
+        if (parent == null)
+            return Collections.emptySet();
+        else
+            return Collections.singleton(parent);
+    }
+
+    /**
+     * Disconnects this node from the network. Can be called publicly.
+     * 
+     * @pre: child nodes, if any, must already be disconnected.
+     */
+    public void disconnectFromNetwork() {
+        if (parent != null)
+            reteContainer.disconnect(parent, this);
+    }
+    
+    @Override
+    public void assignTraceInfo(TraceInfo traceInfo) {
+        super.assignTraceInfo(traceInfo);
+        if (traceInfo.propagateFromStandardNodeToSupplierParent())
+            if (parent != null)
+                parent.acceptPropagatedTraceInfo(traceInfo);
+    }
+
+}
\ No newline at end of file