Module swim.dataflow

Package swim.dataflow

Class AbstractRecordOutlet

java.lang.Object

swim.structure.Item

swim.structure.Value

swim.structure.Record

swim.dataflow.AbstractRecordOutlet

All Implemented Interfaces:

Comparable<Item>, Iterable<Item>, Collection<Item>, List<Item>, Debug, Display, RecordOutlet, MapOutlet<Value,Value,Record>, Outlet<Record>, StreamletScope<Value>, Builder<Item,Record>, PairBuilder<Value,Value,Record>

Direct Known Subclasses:

DownlinkRecord, RecordModel

public abstract class AbstractRecordOutlet
extends Record
implements RecordOutlet

Field Summary

Fields

Modifier and Type	Field	Description
protected HashTrieMap<Value,KeyEffect>	effects
protected HashTrieMap<Value,KeyOutlet<Value,Value>>	outlets
protected Inlet<? super Record>[]	outputs
protected int	version

Constructor Summary

Constructors

Constructor	Description
AbstractRecordOutlet()

Method Summary

Modifier and Type	Method	Description
void	bindOutput(Inlet<? super Record> output)	Adds an output to the set of Inlets that depend on the state of this Outlet.
boolean	containsOwnKey(Value key)
void	decohereInput()	Marks this Outlet—and all outputs that depend on the state of this Outlet—as having decoherent state.
void	decohereInputKey(Value key, KeyEffect effect)	Marks this MapOutlet as needing an effect applied to a given key.
protected void	didDecohereInput()
protected void	didDecohereInputKey(Value key, KeyEffect effect)
protected void	didRecohereInput(int version)
protected void	didRecohereInputKey(Value key, KeyEffect effect, int version)
void	disconnectInputs()	Disconnects all Inlets dominated by this Outlet in the dataflow dependency graph.
void	disconnectOutputs()	Disconnects all Outlets dominated by this Outlet in the dataflow graph.
Record	get()	Returns the current state of this Outlet.
abstract Iterator<Value>	keyIterator()	Returns an Iterator over the keys in the current state of this MapOutlet.
protected void	onDecohereInput()
protected void	onDecohereInputKey(Value key, KeyEffect effect)
protected void	onRecohereInput(int version)
protected void	onRecohereInputKey(Value key, KeyEffect effect, int version)
Outlet<Value>	outlet(String key)	Returns an Outlet that updates when the specified key updates.
Outlet<Value>	outlet(Value key)	Returns an Outlet that updates when the specified key updates.
Iterator<Inlet<? super Record>>	outputIterator()	Returns an Iterator over the set of Inlets that depend on the state of this Outlet.
void	recohereInput(int version)	Updates the state of this Outlet to make it consistent with the target version.
void	recohereInputKey(Value key, int version)	Updates the state of an individual key in this MapOutlet to make it consistent with the target version.
StreamletContext	streamletContext()	Returns the environment in which this StreamletScope operates.
StreamletScope<? extends Value>	streamletScope()	Returns the lexically scoped parent of this StreamletScope.
void	unbindOutput(Inlet<? super Record> output)	Removes an output from the set of Inlets that depend on the state of this Outlet.
void	unbindOutputs()	Disconnects all outputs from this Outlet by invoking Inlet.unbindInput() on each Inelt that depends on the state of this Outlet.
protected void	willDecohereInput()
protected void	willDecohereInputKey(Value key, KeyEffect effect)
protected void	willRecohereInput(int version)
protected void	willRecohereInputKey(Value key, KeyEffect effect, int version)

Methods inherited from class swim.structure.Record

add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addAll, addAll, alias, appended, appended, asMutable, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, attr, bind, body, branch, clear, commit, compareTo, compareTo, concat, contains, contains, containsAll, containsKey, containsKey, containsValue, create, create, debug, empty, entrySet, equals, evaluate, fieldCount, fieldIterator, fieldSet, flattened, get, get, get, getAttr, getAttr, getField, getField, getItem, getSlot, getSlot, hashCode, head, header, headers, indexOf, isAliased, isArray, isConstant, isDefinite, isEmpty, isMutable, isObject, item, item, item, item, item, item, item, iterator, keySet, lastIndexOf, length, listIterator, listIterator, of, of, of, prepended, prepended, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putAttr, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, putSlot, remove, remove, removeAll, removed, removed, removeKey, removeKey, retainAll, set, setItem, setItem, setItem, setItem, setItem, setItem, setItem, size, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, slot, stringValue, stringValue, subList, substitute, tag, tail, target, toArray, toArray, typeOrder, unflattened, updated, updated, updatedAttr, updatedAttr, updatedSlot, updatedSlot, valueCount, valueIterator, values

Methods inherited from class swim.structure.Value

absent, and, and, bitwiseAnd, bitwiseAnd, bitwiseNot, bitwiseOr, bitwiseOr, bitwiseXor, bitwiseXor, booleanValue, booleanValue, builder, byteValue, byteValue, charValue, charValue, conditional, conditional, divide, divide, doubleValue, doubleValue, eq, eq, extant, floatValue, floatValue, fromObject, ge, ge, gt, gt, integerValue, integerValue, intValue, intValue, inverse, isDefined, isDistinct, key, keyEquals, lambda, le, le, longValue, longValue, lt, lt, minus, minus, modulo, modulo, ne, ne, negative, not, numberValue, numberValue, or, or, plus, plus, positive, shortValue, shortValue, times, times, toValue

Methods inherited from class swim.structure.Item

appended, appended, appended, appended, appended, appended, cast, cast, coerce, coerce, display, evaluate, filter, filter, globalScope, invoke, max, min, precedence, prepended, prepended, prepended, prepended, prepended, prepended, substitute, toString, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface swim.streamlet.MapOutlet

containsKey, filter, get, map, memoize, reduce, watch

Methods inherited from interface swim.streamlet.Outlet

map, watch

Field Detail

effects

protected HashTrieMap<Value,KeyEffect> effects

outlets

protected HashTrieMap<Value,KeyOutlet<Value,Value>> outlets

outputs

protected Inlet<? super Record>[] outputs

version

protected int version

Constructor Detail

AbstractRecordOutlet

public AbstractRecordOutlet()

Method Detail

streamletScope

public StreamletScope<? extends Value> streamletScope()

Description copied from interface: StreamletScope

Returns the lexically scoped parent of this StreamletScope. Returns null if this StreamletScope has no lexical parent.

Specified by:

streamletScope in interface StreamletScope<Value>

streamletContext

public StreamletContext streamletContext()

Description copied from interface: StreamletScope

Returns the environment in which this StreamletScope operates.

Specified by:

streamletContext in interface StreamletScope<Value>

containsOwnKey

public boolean containsOwnKey(Value key)

keyIterator

public abstract Iterator<Value> keyIterator()

Description copied from interface: MapOutlet

Returns an Iterator over the keys in the current state of this MapOutlet.

Specified by:

keyIterator in interface MapOutlet<Value,Value,Record>

Overrides:

keyIterator in class Record

get

public Record get()

Description copied from interface: Outlet

Returns the current state of this Outlet.

Specified by:

get in interface Outlet<Record>

outlet

public Outlet<Value> outlet(Value key)

Description copied from interface: MapOutlet

Returns an Outlet that updates when the specified key updates.

Specified by:

outlet in interface MapOutlet<Value,Value,Record>

Specified by:

outlet in interface RecordOutlet

outlet

public Outlet<Value> outlet(String key)

Description copied from interface: StreamletScope

Returns an Outlet that updates when the specified key updates.

Specified by:

outlet in interface RecordOutlet

Specified by:

outlet in interface StreamletScope<Value>

outputIterator

public Iterator<Inlet<? super Record>> outputIterator()

Description copied from interface: Outlet

Returns an Iterator over the set of Inlets that depend on the state of this Outlet.

Specified by:

outputIterator in interface Outlet<Record>

bindOutput

public void bindOutput(Inlet<? super Record> output)

Description copied from interface: Outlet

Adds an output to the set of Inlets that depend on the state of this Outlet. The output will be decohered when the state of this Outlet is decohered, and recohered when this Outlet is recohered.

Specified by:

bindOutput in interface Outlet<Record>

unbindOutput

public void unbindOutput(Inlet<? super Record> output)

Description copied from interface: Outlet

Removes an output from the set of Inlets that depend on the state of this Outlet.

Specified by:

unbindOutput in interface Outlet<Record>

unbindOutputs

public void unbindOutputs()

Description copied from interface: Outlet

Disconnects all outputs from this Outlet by invoking Inlet.unbindInput() on each Inelt that depends on the state of this Outlet.

Specified by:

unbindOutputs in interface Outlet<Record>

disconnectOutputs

public void disconnectOutputs()

Description copied from interface: Outlet

Disconnects all Outlets dominated by this Outlet in the dataflow graph. Used to recursively clean up chains of combinators originating from this Inlet.

Specified by:

disconnectOutputs in interface Outlet<Record>

disconnectInputs

public void disconnectInputs()

Description copied from interface: Outlet

Disconnects all Inlets dominated by this Outlet in the dataflow dependency graph. Used to recursively clean up chains of combinators passing through this Outlet.

Specified by:

disconnectInputs in interface Outlet<Record>

decohereInputKey

public void decohereInputKey(Value key,
                             KeyEffect effect)

Description copied from interface: MapOutlet

Marks this MapOutlet as needing an effect applied to a given key. Decohering an individual key decoheres the entire state of the Outlet. But only the decoherent keys need to be updated in order to recohere the overall state of the Outlet.

Specified by:

decohereInputKey in interface MapOutlet<Value,Value,Record>

decohereInput

public void decohereInput()

Description copied from interface: Outlet

Marks this Outlet—and all outputs that depend on the state of this Outlet—as having decoherent state.

Specified by:

decohereInput in interface Outlet<Record>

recohereInputKey

public void recohereInputKey(Value key,
                             int version)

Description copied from interface: MapOutlet

Updates the state of an individual key in this MapOutlet to make it consistent with the target version. The MapOutlet only needs to update if its current version differs from the target version. To update the state of a key, the MapOutlet first invokes Streamlet.recohere(int) on its attached streamlets. Then, for each dependent output, it invokes MapInlet.recohereOutputKey(Object, int), if the dependent output is a MapInlet, or it invokes Inlet.recohereOutput(int), if the dependent output is not a MapInlet.

Specified by:

recohereInputKey in interface MapOutlet<Value,Value,Record>

recohereInput

public void recohereInput(int version)

Description copied from interface: Outlet

Updates the state of this Outlet to make it consistent with the target version. The Outlet only needs to update if its current version differs from the target version. To update its state, the Outlet first invokes Streamlet.recohere(int) on the Streamlet to which it's attached. It then invokes Inlet.recohereOutput(int) on each of its dependent outputs.

Specified by:

recohereInput in interface Outlet<Record>

willDecohereInputKey

protected void willDecohereInputKey(Value key,
                                    KeyEffect effect)

onDecohereInputKey

protected void onDecohereInputKey(Value key,
                                  KeyEffect effect)

didDecohereInputKey

protected void didDecohereInputKey(Value key,
                                   KeyEffect effect)

willDecohereInput

protected void willDecohereInput()

onDecohereInput

protected void onDecohereInput()

didDecohereInput

protected void didDecohereInput()

willRecohereInputKey

protected void willRecohereInputKey(Value key,
                                    KeyEffect effect,
                                    int version)

onRecohereInputKey

protected void onRecohereInputKey(Value key,
                                  KeyEffect effect,
                                  int version)

didRecohereInputKey

protected void didRecohereInputKey(Value key,
                                   KeyEffect effect,
                                   int version)

willRecohereInput

protected void willRecohereInput(int version)

onRecohereInput

protected void onRecohereInput(int version)

didRecohereInput

protected void didRecohereInput(int version)