Module swim.streamlet

Package swim.streamlet

Class AbstractMapInlet<K,V,O>

java.lang.Object

swim.streamlet.AbstractMapInlet<K,V,O>

All Implemented Interfaces:

Inlet<O>, MapInlet<K,V,O>

Direct Known Subclasses:

MapOutput, OutletMapInlet, WatchFieldsOperator

public abstract class AbstractMapInlet<K,V,O>
extends Object
implements MapInlet<K,V,O>

Field Summary

Fields

Modifier and Type	Field	Description
protected HashTrieMap<K,KeyEffect>	effects
protected MapOutlet<K,V,? extends O>	input
protected int	version

Constructor Summary

Constructors

Constructor	Description
AbstractMapInlet()

Method Summary

Modifier and Type	Method	Description
void	bindInput(MapOutlet<K,V,? extends O> input)
void	bindInput(Outlet<? extends O> input)	Connects this Inlet to an Outlet from which it will acquire its state.
protected void	didInvalidateOutput()
protected void	didInvalidateOutputKey(K key, KeyEffect effect)
protected void	didReconcileOutput(int version)
protected void	didReconcileOutputKey(K key, KeyEffect effect, int version)
void	disconnectInputs()	Disconnects all Inlets dominated by this Inlet in the dataflow dependency graph.
void	disconnectOutputs()	Disconnects all Outlets dominated by this Inlet in the dataflow graph.
MapOutlet<K,V,? extends O>	input()	Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.
void	invalidateOutput()	Marks this Inlet—and the Streamlet to which this Inlet is attached—as having stale state.
void	invalidateOutputKey(K key, KeyEffect effect)	Marks this MapInlet as needing an effect applied to a given key.
protected void	onInvalidateOutput()
protected void	onInvalidateOutputKey(K key, KeyEffect effect)
protected void	onReconcileOutput(int version)
protected void	onReconcileOutputKey(K key, KeyEffect effect, int version)
void	reconcileOutput(int version)	Reconciles the state of this Inlet, if the version of this Inlet's state differs from the target version.
void	reconcileOutputKey(K key, int version)	Reconciles the state of an individual key in this MapInlet, if the version of this MapInlet's state differs from the target version.
void	unbindInput()	Disconnects this Inlet from its input Outlet, if connected.
protected void	willInvalidateOutput()
protected void	willInvalidateOutputKey(K key, KeyEffect effect)
protected void	willReconcileOutput(int version)
protected void	willReconcileOutputKey(K key, KeyEffect effect, int version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

input

protected MapOutlet<K,V,? extends O> input

effects

protected HashTrieMap<K,KeyEffect> effects

version

protected int version

Constructor Detail

AbstractMapInlet

public AbstractMapInlet()

Method Detail

input

public MapOutlet<K,V,? extends O> input()

Description copied from interface: Inlet

Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.

Specified by:

input in interface Inlet<K>

bindInput

public void bindInput(Outlet<? extends O> input)

Description copied from interface: Inlet

Connects this Inlet to an Outlet from which it will acquire its state. If this Inlet is already connected, it will first disconnect from its existing input. Then, after updating its input property, the Inlet will invoke Outlet.bindOutput(Inlet) on its new input.

Specified by:

bindInput in interface Inlet<K>

bindInput

public void bindInput(MapOutlet<K,V,? extends O> input)

unbindInput

public void unbindInput()

Description copied from interface: Inlet

Disconnects this Inlet from its input Outlet, if connected. After setting its input property to null, the Inlet will invoke Outlet.unbindOutput(Inlet) on its old input, if defined.

Specified by:

unbindInput in interface Inlet<K>

disconnectInputs

public void disconnectInputs()

Description copied from interface: Inlet

Disconnects all Inlets dominated by this Inlet in the dataflow dependency graph. Used to recursively clean up chains of combinators terminating at this Inlet.

Specified by:

disconnectInputs in interface Inlet<K>

disconnectOutputs

public void disconnectOutputs()

Description copied from interface: Inlet

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

Specified by:

disconnectOutputs in interface Inlet<K>

invalidateOutputKey

public void invalidateOutputKey(K key,
                                KeyEffect effect)

Description copied from interface: MapInlet

Marks this MapInlet as needing an effect applied to a given key. Invalidating an individual key invalidates the entire state of the Inlet. But only the invalidated keys need to be updated in order to reconcile the overall state of the Inlet.

Specified by:

invalidateOutputKey in interface MapInlet<K,V,O>

invalidateOutput

public void invalidateOutput()

Description copied from interface: Inlet

Marks this Inlet—and the Streamlet to which this Inlet is attached—as having stale state. Invalidating an Inlet will recursively invalidate all streamlets that transitively depend on the state of this Inlet. Invalidating an Inlet does not cause its state to be recomputed. A subsequent Inlet.reconcileOutput(int) call will reconcile the state of the Inlet.

Specified by:

invalidateOutput in interface Inlet<K>

reconcileOutputKey

public void reconcileOutputKey(K key,
                               int version)

Description copied from interface: MapInlet

Reconciles the state of an individual key in this MapInlet, if the version of this MapInlet's state differs from the target version. To reconcile the state of a key, the MapInlet first invokes MapOutlet.reconcileInputKey(Object, int) on its input, if its input is a MapOutlet, or it invokes Outlet.reconcileInput(int), if its input is not a MapOutlet. Then, if all invalid keys have been reconciled, the MapInlet invokes Streamlet.reconcile(int) on its attached streamlet.

Specified by:

reconcileOutputKey in interface MapInlet<K,V,O>

reconcileOutput

public void reconcileOutput(int version)

Description copied from interface: Inlet

Reconciles the state of this Inlet, if the version of this Inlet's state differs from the target version. To reconcile its state, the Inlet first invokes Outlet.reconcileInput(int) on its input, to ensure that its input is up-to-date. It then invokes Streamlet.reconcile(int) on the Streamlet to which it's attached, causing the Streamlet to reconcile its own state.

Specified by:

reconcileOutput in interface Inlet<K>

willInvalidateOutputKey

protected void willInvalidateOutputKey(K key,
                                       KeyEffect effect)

onInvalidateOutputKey

protected void onInvalidateOutputKey(K key,
                                     KeyEffect effect)

didInvalidateOutputKey

protected void didInvalidateOutputKey(K key,
                                      KeyEffect effect)

willInvalidateOutput

protected void willInvalidateOutput()

onInvalidateOutput

protected void onInvalidateOutput()

didInvalidateOutput

protected void didInvalidateOutput()

willReconcileOutputKey

protected void willReconcileOutputKey(K key,
                                      KeyEffect effect,
                                      int version)

onReconcileOutputKey

protected void onReconcileOutputKey(K key,
                                    KeyEffect effect,
                                    int version)

didReconcileOutputKey

protected void didReconcileOutputKey(K key,
                                     KeyEffect effect,
                                     int version)

willReconcileOutput

protected void willReconcileOutput(int version)

onReconcileOutput

protected void onReconcileOutput(int version)

didReconcileOutput

protected void didReconcileOutput(int version)