Package io.deephaven.engine.table.impl

Class BaseTable.ListenerImpl

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessArtifact

io.deephaven.engine.table.impl.InstrumentedTableListenerBase

io.deephaven.engine.table.impl.InstrumentedTableUpdateListener

io.deephaven.engine.table.impl.BaseTable.ListenerImpl

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, TableListener, TableUpdateListener, NotificationQueue.Dependency, Serializable

Direct Known Subclasses:

SnapshotInternalListener, SortedAssertionInstrumentedListenerAdapter, SortListener

Enclosing class:

BaseTable<IMPL_TYPE extends BaseTable<IMPL_TYPE>>

public static class BaseTable.ListenerImpl
extends InstrumentedTableUpdateListener

Simplest appropriate InstrumentedShiftAwareListener implementation for BaseTable and descendants. It's expected that most use-cases will require overriding onUpdate() - the default implementation simply passes rowSet updates through to the dependent's listeners.

See Also:

• Serialized Form

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

Constructors

Constructor	Description
ListenerImpl(String description, Table parent, BaseTable<?> dependent)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(long step)
protected void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
protected BaseTable<?>	getDependent()
protected Table	getParent()
void	onFailureInternal(Throwable originalException, TableListener.Entry sourceEntry)
void	onUpdate(TableUpdate upstream)	Process notification of table changes.

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

Constructor Details

ListenerImpl

public ListenerImpl(String description,
 Table parent,
 BaseTable<?> dependent)

Method Details

onUpdate

public void onUpdate(TableUpdate upstream)

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, with Table.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

public void onFailureInternal(Throwable originalException,
 TableListener.Entry sourceEntry)

Specified by:

onFailureInternal in class InstrumentedTableListenerBase

canExecute

public boolean canExecute(long step)

Overrides:

canExecute in class InstrumentedTableListenerBase

destroy

@OverridingMethodsMustInvokeSuper
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 class ReferenceCountedLivenessReferent

getParent

protected Table getParent()

getDependent

protected BaseTable<?> getDependent()