1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*******************************************************************************
* Copyright (c) 2010-2015, 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.boundary;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import tools.refinery.viatra.runtime.matchers.context.IInputKey;
import tools.refinery.viatra.runtime.matchers.context.IQueryBackendContext;
import tools.refinery.viatra.runtime.matchers.context.IQueryRuntimeContext;
import tools.refinery.viatra.runtime.matchers.context.IQueryRuntimeContextListener;
import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
import tools.refinery.viatra.runtime.matchers.tuple.TupleMask;
import tools.refinery.viatra.runtime.matchers.tuple.Tuples;
import tools.refinery.viatra.runtime.matchers.util.Direction;
import tools.refinery.viatra.runtime.matchers.util.timeline.Timeline;
import tools.refinery.viatra.runtime.rete.matcher.ReteEngine;
import tools.refinery.viatra.runtime.rete.network.Network;
import tools.refinery.viatra.runtime.rete.network.Receiver;
import tools.refinery.viatra.runtime.rete.network.ReteContainer;
import tools.refinery.viatra.runtime.rete.network.StandardNode;
import tools.refinery.viatra.runtime.rete.network.Supplier;
import tools.refinery.viatra.runtime.rete.network.communication.Timestamp;
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.remote.Address;
/**
* An input node representing an enumerable extensional input relation and receiving external updates.
*
* <p>
* Contains those tuples that are in the extensional relation identified by the input key, and also conform to the
* global seed (if any).
*
* @author Bergmann Gabor
*
*/
public class ExternalInputEnumeratorNode extends StandardNode
implements Disconnectable, Receiver, IQueryRuntimeContextListener {
private IQueryRuntimeContext context = null;
private IInputKey inputKey;
private Tuple globalSeed;
private InputConnector inputConnector;
private Network network;
private Address<? extends Receiver> myAddress;
private boolean parallelExecutionEnabled;
/**
* @since 1.6
*/
protected final Mailbox mailbox;
private final IQueryBackendContext qBackendContext;
public ExternalInputEnumeratorNode(ReteContainer reteContainer) {
super(reteContainer);
myAddress = Address.of(this);
network = reteContainer.getNetwork();
inputConnector = network.getInputConnector();
qBackendContext = network.getEngine().getBackendContext();
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;
}
public void connectThroughContext(ReteEngine engine, IInputKey inputKey, Tuple globalSeed) {
this.inputKey = inputKey;
this.globalSeed = globalSeed;
setTag(inputKey);
final IQueryRuntimeContext context = engine.getRuntimeContext();
if (!context.getMetaContext().isEnumerable(inputKey))
throw new IllegalArgumentException(this.getClass().getSimpleName()
+ " only applicable for enumerable input keys; received instead " + inputKey);
this.context = context;
this.parallelExecutionEnabled = engine.isParallelExecutionEnabled();
engine.addDisconnectable(this);
context.addUpdateListener(inputKey, globalSeed, this);
}
@Override
public void disconnect() {
if (context != null) { // if connected
context.removeUpdateListener(inputKey, globalSeed, this);
context = null;
}
}
/**
* @since 2.2
*/
protected Iterable<Tuple> getTuplesInternal() {
Iterable<Tuple> tuples = null;
if (context != null) { // if connected
if (globalSeed == null) {
tuples = context.enumerateTuples(inputKey, TupleMask.empty(inputKey.getArity()),
Tuples.staticArityFlatTupleOf());
} else {
final TupleMask mask = TupleMask.fromNonNullIndices(globalSeed);
tuples = context.enumerateTuples(inputKey, mask, mask.transform(globalSeed));
}
}
return tuples;
}
@Override
public void pullInto(final Collection<Tuple> collector, final boolean flush) {
final Iterable<Tuple> tuples = getTuplesInternal();
if (tuples != null) {
for (final Tuple tuple : tuples) {
collector.add(tuple);
}
}
}
@Override
public void pullIntoWithTimeline(final Map<Tuple, Timeline<Timestamp>> collector, final boolean flush) {
final Iterable<Tuple> tuples = getTuplesInternal();
if (tuples != null) {
for (final Tuple tuple : tuples) {
collector.put(tuple, Timestamp.INSERT_AT_ZERO_TIMELINE);
}
}
}
/* Update from runtime context */
@Override
public void update(IInputKey key, Tuple update, boolean isInsertion) {
if (parallelExecutionEnabled) {
// send back to myself as an official external update, and then propagate it transparently
network.sendExternalUpdate(myAddress, direction(isInsertion), update);
} else {
if (qBackendContext.areUpdatesDelayed()) {
// post the update into the mailbox of the node
mailbox.postMessage(direction(isInsertion), update, Timestamp.ZERO);
} else {
// just propagate the input
update(direction(isInsertion), update, Timestamp.ZERO);
}
// if the the update method is called from within a delayed execution,
// the following invocation will be a no-op
network.waitForReteTermination();
}
}
private static Direction direction(boolean isInsertion) {
return isInsertion ? Direction.INSERT : Direction.DELETE;
}
/* Self-addressed from network */
@Override
public void update(Direction direction, Tuple updateElement, Timestamp timestamp) {
propagateUpdate(direction, updateElement, timestamp);
}
@Override
public void appendParent(Supplier supplier) {
throw new UnsupportedOperationException("Input nodes can't have parents");
}
@Override
public void removeParent(Supplier supplier) {
throw new UnsupportedOperationException("Input nodes can't have parents");
}
@Override
public Collection<Supplier> getParents() {
return Collections.emptySet();
}
public IInputKey getInputKey() {
return inputKey;
}
public Tuple getGlobalSeed() {
return globalSeed;
}
}
|
