Module swim.streamlet

Package swim.streamlet

Class AbstractMapOutlet<K,V,O>

java.lang.Object

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

All Implemented Interfaces:

MapOutlet<K,V,O>, Outlet<O>

Direct Known Subclasses:

MapInput

public abstract class AbstractMapOutlet<K,V,O>
extends Object
implements MapOutlet<K,V,O>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
AbstractMapOutlet()

Method Summary

Modifier and Type	Method	Description
void	bindOutput(Inlet<? super O> output)	Adds an output to the set of Inlets that depend on the state of this Outlet.
abstract boolean	containsKey(K key)	Returns true if the current state of this MapOutlet contains the given key; otherwise returns false.
protected void	didInvalidateInput()
protected void	didInvalidateInputKey(K key, KeyEffect effect)
protected void	didReconcileInput(int version)
protected void	didReconcileInputKey(K 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.
abstract O	get()	Returns the current state of this Outlet.
abstract V	get(K key)	Returns the value assocaited with the given key in the current state of this MapOutlet, if defined; otherwise returns null.
void	invalidateInput()	Marks this Outlet—and all outputs that depend on the state of this Outlet—as having stale state.
void	invalidateInputKey(K key, KeyEffect effect)	Marks this MapOutlet as needing an effect applied to a given key.
abstract Iterator<K>	keyIterator()	Returns an Iterator over the keys in the current state of this MapOutlet.
protected void	onInvalidateInput()
protected void	onInvalidateInputKey(K key, KeyEffect effect)
protected void	onReconcileInput(int version)
protected void	onReconcileInputKey(K key, KeyEffect effect, int version)
Outlet<V>	outlet(K key)	Returns an Outlet that updates when the specified key updates.
Iterator<Inlet<? super O>>	outputIterator()	Returns an Iterator over the set of Inlets that depend on the state of this Outlet.
void	reconcileInput(int version)	Reconciles the state of this Outlet, if the version of this Outlet's state differs from the target version.
void	reconcileInputKey(K key, int version)	Reconciles the state of an individual key in this MapOutlet, if the version of this MapOutlet's state differs from the target version.
void	unbindOutput(Inlet<? super O> 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	willInvalidateInput()
protected void	willInvalidateInputKey(K key, KeyEffect effect)
protected void	willReconcileInput(int version)
protected void	willReconcileInputKey(K key, KeyEffect effect, int version)

Methods inherited from class java.lang.Object

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

Methods inherited from interface swim.streamlet.MapOutlet

filter, map, memoize, reduce, watch

Methods inherited from interface swim.streamlet.Outlet

map, watch

Field Detail

effects

protected HashTrieMap<K,KeyEffect> effects

outlets

protected HashTrieMap<K,KeyOutlet<K,V>> outlets

outputs

protected Inlet<? super O>[] outputs

version

protected int version

Constructor Detail

AbstractMapOutlet

public AbstractMapOutlet()

Method Detail

containsKey

public abstract boolean containsKey(K key)

Description copied from interface: MapOutlet

Returns true if the current state of this MapOutlet contains the given key; otherwise returns false.

Specified by:

containsKey in interface MapOutlet<K,V,O>

get

public abstract V get(K key)

Description copied from interface: MapOutlet

Returns the value assocaited with the given key in the current state of this MapOutlet, if defined; otherwise returns null.

Specified by:

get in interface MapOutlet<K,V,O>

get

public abstract O get()

Description copied from interface: Outlet

Returns the current state of this Outlet.

Specified by:

get in interface Outlet<K>

keyIterator

public abstract Iterator<K> 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<K,V,O>

outlet

public Outlet<V> outlet(K key)

Description copied from interface: MapOutlet

Returns an Outlet that updates when the specified key updates.

Specified by:

outlet in interface MapOutlet<K,V,O>

outputIterator

public Iterator<Inlet<? super O>> 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<K>

bindOutput

public void bindOutput(Inlet<? super O> 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 invalidated when the state of this Outlet is invalidated, and updated when this Outlet is updated.

Specified by:

bindOutput in interface Outlet<K>

unbindOutput

public void unbindOutput(Inlet<? super O> 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<K>

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<K>

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<K>

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<K>

invalidateInputKey

public void invalidateInputKey(K key,
                               KeyEffect effect)

Description copied from interface: MapOutlet

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

Specified by:

invalidateInputKey in interface MapOutlet<K,V,O>

invalidateInput

public void invalidateInput()

Description copied from interface: Outlet

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

Specified by:

invalidateInput in interface Outlet<K>

reconcileInputKey

public void reconcileInputKey(K key,
                              int version)

Description copied from interface: MapOutlet

Reconciles the state of an individual key in this MapOutlet, if the version of this MapOutlet's state differs from the target version. To reconcile the state of a key, the MapOutlet first invokes Streamlet.reconcile(int) on its attached streamlets. Then, for each dependent output, it invokes MapInlet.reconcileOutputKey(Object, int), if the dependent output is a MapInlet, or it invokes Inlet.reconcileOutput(int), if the dependent output is not a MapInlet.

Specified by:

reconcileInputKey in interface MapOutlet<K,V,O>

reconcileInput

public void reconcileInput(int version)

Description copied from interface: Outlet

Reconciles the state of this Outlet, if the version of this Outlet's state differs from the target version. To reconcile its state, the Outlet first invokes Streamlet.reconcile(int) on the Streamlet to which it's attached. It then invokes Inlet.reconcileOutput(int) on each of its dependent outputs.

Specified by:

reconcileInput in interface Outlet<K>

willInvalidateInputKey

protected void willInvalidateInputKey(K key,
                                      KeyEffect effect)

onInvalidateInputKey

protected void onInvalidateInputKey(K key,
                                    KeyEffect effect)

didInvalidateInputKey

protected void didInvalidateInputKey(K key,
                                     KeyEffect effect)

willInvalidateInput

protected void willInvalidateInput()

onInvalidateInput

protected void onInvalidateInput()

didInvalidateInput

protected void didInvalidateInput()

willReconcileInputKey

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

onReconcileInputKey

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

didReconcileInputKey

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

willReconcileInput

protected void willReconcileInput(int version)

onReconcileInput

protected void onReconcileInput(int version)

didReconcileInput

protected void didReconcileInput(int version)