Package io.deephaven.engine.table.impl
Class ListenerRecorder
java.lang.Object
- All Implemented Interfaces:
LogOutputAppendable
,LivenessManager
,LivenessNode
,LivenessReferent
,TableListener
,TableUpdateListener
,NotificationQueue.Dependency
,Serializable
- Direct Known Subclasses:
JoinListenerRecorder
A listener recorder stores references to added, removed, modified, and shifted indices; and then notifies a
MergedListener
that a change has occurred. The combination of a ListenerRecorder
and
MergedListener
should be used when a table has multiple sources, such that each table can process all of its
dependencies at once and fire a single notification to its children.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.InstrumentedTableUpdateListener
InstrumentedTableUpdateListener.Notification
Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.InstrumentedTableListenerBase
InstrumentedTableListenerBase.ErrorNotification, InstrumentedTableListenerBase.NotificationBase
Nested classes/interfaces inherited from interface io.deephaven.engine.table.TableListener
TableListener.Entry
-
Field Summary
Fields inherited from class io.deephaven.engine.table.impl.InstrumentedTableListenerBase
failed
-
Constructor Summary
ConstructorDescriptionListenerRecorder
(@NotNull String description, @NotNull Table parent, @Nullable Object dependent) -
Method Summary
Modifier and TypeMethodDescriptionboolean
canExecute
(long step) protected void
destroy()
Attempt to release (destructively when necessary) resources held by this object.getAdded()
long
protected void
onFailureInternal
(@NotNull Throwable originalException, @Nullable TableListener.Entry sourceEntry) void
onUpdate
(TableUpdate upstream) Process notification of table changes.boolean
void
release()
void
setMergedListener
(MergedListener mergedListener) protected void
setNotificationStep
(long step) Methods inherited from class io.deephaven.engine.table.impl.InstrumentedTableUpdateListener
getNotification
Methods inherited from class io.deephaven.engine.table.impl.InstrumentedTableListenerBase
append, getEntry, getErrorNotification, getUpdateGraph, onFailure, onFailureInternalWithDependent, satisfied, setVerboseLogging, toString
Methods inherited from class io.deephaven.engine.liveness.LivenessArtifact
manageWithCurrentScope
Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode
getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage
Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent
dropReference, tryRetainReference
Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted
decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, tryDecrementReferenceCount, tryIncrementReferenceCount
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.deephaven.engine.liveness.LivenessManager
manage, tryManage
Methods inherited from interface io.deephaven.engine.liveness.LivenessNode
tryUnmanage, tryUnmanage, unmanage, unmanage
Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent
dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference
Methods inherited from interface io.deephaven.engine.updategraph.NotificationQueue.Dependency
getUpdateGraph
Methods inherited from interface io.deephaven.engine.table.TableListener
getErrorNotification, onFailure
-
Field Details
-
parent
-
logPrefix
-
-
Constructor Details
-
ListenerRecorder
-
-
Method Details
-
getParent
-
release
public void release() -
onUpdate
Description copied from interface:TableUpdateListener
Process notification of table changes.The TableUpdateListener onUpdate call executes within the
UpdateGraph
refresh loop. Any tables used within the listener's onUpdate call must have already been refreshed. Using the typical pattern of a Listener that is listening to a single table, withTable.addUpdateListener(TableUpdateListener)
, this is trivially true.When the listener must reference more than just one parent, the tables (or other objects) it references, must be made a
NotificationQueue.Dependency
of the listener. For listeners that reference multiple ticking tables, a common pattern is to use a MergedListener and collection of ListenerRecorders.- Parameters:
upstream
- The set of upstream table updates.
-
onFailureInternal
protected void onFailureInternal(@NotNull @NotNull Throwable originalException, @Nullable @Nullable TableListener.Entry sourceEntry) - Specified by:
onFailureInternal
in classInstrumentedTableListenerBase
-
setNotificationStep
protected void setNotificationStep(long step) -
canExecute
public boolean canExecute(long step) - Overrides:
canExecute
in classInstrumentedTableListenerBase
-
destroy
protected void destroy()Description copied from class:ReferenceCountedLivenessReferent
Attempt to release (destructively when necessary) resources held by this object. This may render the object unusable for subsequent operations. Implementations should be sure to call super.destroy().This is intended to only ever be used as a side effect of decreasing the reference count to 0.
- Overrides:
destroy
in classReferenceCountedLivenessReferent
-
recordedVariablesAreValid
public boolean recordedVariablesAreValid() -
setMergedListener
-
getNotificationStep
public long getNotificationStep() -
getAdded
-
getRemoved
-
getModified
-
getModifiedPreShift
-
getShifted
-
getModifiedColumnSet
-
getUpdate
-