Package io.deephaven.barrage.table

Class BarrageTable

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

com.illumon.iris.db.util.liveness.ReferenceCountedLivenessNode

com.illumon.iris.db.util.liveness.LivenessArtifact

com.illumon.iris.db.v2.BaseTable

com.illumon.iris.db.v2.QueryTable

io.deephaven.barrage.table.BarrageTable

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, NotificationQueue.Dependency, Deflatable<Table>, Table, LivenessManager, LivenessNode, LivenessReferent, LongSizedDataStructure, DynamicNode, DynamicTable, NotificationStepReceiver, NotificationStepSource, SystemicObject, BarrageMessage.Listener, Serializable

Direct Known Subclasses:

BarrageBlinkTable, BarrageRedirectedTable

public abstract class BarrageTable
extends QueryTable
implements BarrageMessage.Listener

A client side Table that mirrors an upstream/server side Table.

Note that viewports are defined in row positions of the upstream table.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	BarrageTable.Stats
static interface	BarrageTable.ViewportChangedCallback

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.QueryTable

QueryTable.FilteredTable, QueryTable.MemoizableOperation, QueryTable.Operation

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.BaseTable

BaseTable.CopyAttributeOperation, BaseTable.ListenerImpl, BaseTable.ShiftAwareListenerImpl, BaseTable.SwapListenerFactory<T extends SwapListenerBase>

Nested classes/interfaces inherited from interface com.illumon.iris.db.tables.Table

Table.AsOfMatchRule, Table.GroupStrategy, Table.RenameFunction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BARRAGE_PERFORMANCE_KEY_ATTRIBUTE	Set this attribute to enable collection of barrage performance stats.
protected static final int	BATCH_SIZE
protected long	capacity	the capacity that the destSources been set to
static final boolean	DEBUG_ENABLED
protected final WritableSource<?>[]	destSources	the reinterpreted destination writable sources
protected final BarrageTable.Stats	stats

Fields inherited from class com.illumon.iris.db.v2.QueryTable

modifiedColumnSet, USE_CHUNKED_CROSS_JOIN, USE_UNTRACKED_LASTBY_FOR_AUTOMATED_FILTERS

Fields inherited from class com.illumon.iris.db.v2.BaseTable

attributes, definition, description, PRINT_SERIALIZED_UPDATE_OVERLAPS, sharedAttributes

Fields inherited from interface com.illumon.iris.db.v2.NotificationStepReceiver

NULL_NOTIFICATION_STEP

Fields inherited from interface com.illumon.iris.db.tables.Table

ACL_ATTRIBUTE, ADD_ONLY_TABLE_ATTRIBUTE, COLUMN_DESCRIPTIONS_ATTRIBUTE, COLUMN_RENDERERS_ATTRIBUTE, CUSTOM_ACTIONS_ATTRIBUTE, DO_NOT_MAKE_REMOTE_ATTRIBUTE, EMPTY_SOURCE_TABLE_ATTRIBUTE, FILTERABLE_COLUMNS_ATTRIBUTE, HIERARCHICAL_CHILDREN_TABLE_MAP_ATTRIBUTE, HIERARCHICAL_SOURCE_INFO_ATTRIBUTE, HIERARCHICAL_SOURCE_TABLE_ATTRIBUTE, INPUT_TABLE_ATTRIBUTE, KEY_COLUMNS_ATTRIBUTE, LAYOUT_HINTS_ATTRIBUTE, MERGED_TABLE_ATTRIBUTE, NON_DISPLAY_TABLE, PLUGIN_NAME, PREDEFINED_ROLLUP_ATTRIBUTE, PREEMPTIVE_VIEWPORT_TYPE, PREPARED_RLL_ATTRIBUTE, PREVIEW_PARENT_TABLE, REVERSE_LOOKUP_ATTRIBUTE, ROLLUP_LEAF_ATTRIBUTE, SNAPSHOT_VIEWPORT_TYPE, SORTABLE_COLUMNS_ATTRIBUTE, SORTED_COLUMNS_ATTRIBUTE, SYSTEMIC_TABLE_ATTRIBUTE, TABLE_DESCRIPTION_ATTRIBUTE, TOTALS_TABLE_ATTRIBUTE, TREE_TABLE_FILTER_REVERSE_LOOKUP_ATTRIBUTE, UNIQUE_KEYS_ATTRIBUTE, UNTRACKED_LASTBY_TABLE_ATTRIBUTE, VIEWPORT_TYPE_ATTRIBUTE, ZERO_LENGTH_TABLE_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BarrageTable(LiveTableRegistrar registrar, NotificationQueue notificationQueue, @Nullable ScheduledExecutorService executorService, LinkedHashMap<String,ColumnSource> columns, WritableSource[] writableSources, Map<String,Object> attributes, @Nullable BarrageTable.ViewportChangedCallback viewportChangedCallback)

Method Summary

Modifier and Type	Method	Description
void	addSourceToRegistrar()	Add this table to the registrar so that it can be refreshed.
protected abstract ShiftAwareListener.Update	applyUpdates(ArrayDeque<BarrageMessage> localPendingUpdates)
protected com.fishlib.io.log.LogEntry	beginLog(@NotNull com.fishlib.io.log.LogLevel level)	Convenience method for writing consistent log messages from this object.
protected void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
protected void	doWakeup()
@Nullable Object	getAttribute(@NotNull String key)	Get the value of the specified attribute.
LongConsumer	getDeserializationTmConsumer()
protected NotificationQueue	getNotificationQueue()	Get the notification queue to insert notifications into as they are generated by listeners during DynamicTable.notifyListeners(Index, Index, Index).
BitSet	getServerColumns()
boolean	getServerReverseViewport()
Index	getServerViewport()
ChunkType[]	getWireChunkTypes()
Class<?>[]	getWireComponentTypes()
Class<?>[]	getWireTypes()
void	handleBarrageError(Throwable t)
void	handleBarrageMessage(BarrageMessage update)
protected boolean	isSubscribedColumn(int i)
static BarrageTable	make(@NotNull LiveTableRegistrar registrar, @NotNull NotificationQueue queue, @Nullable ScheduledExecutorService executor, @NotNull TableDefinition tableDefinition, @NotNull Map<String,Object> attributes, @Nullable BarrageTable.ViewportChangedCallback vpCallback)
static BarrageTable	make(@Nullable ScheduledExecutorService executorService, TableDefinition tableDefinition, Map<String,Object> attributes, @Nullable BarrageTable.ViewportChangedCallback vpCallback)	Set up a replicated table from the given proxy, id and columns.
protected static @NotNull LinkedHashMap<String,ColumnSource>	makeColumns(@NotNull List<ColumnDefinition> columns, @NotNull WritableSource<?>[] writableSources, @NotNull RedirectionIndex emptyRowRedirection)	Set up the columns for the replicated redirected table.
protected static @NotNull LinkedHashMap<String,ColumnSource>	makeColumns(List<ColumnDefinition> columns, WritableSource<?>[] writableSources)	Set up the columns for the replicated blink table.
protected boolean	maybeEnablePrevTracking()
protected void	recordMetric(Function<BarrageTable.Stats,org.HdrHistogram.Histogram> hist, long value)
protected void	saveForDebugging(BarrageMessage snapshotOrDelta)
protected void	updateServerViewport(Index viewport, BitSet columns, boolean reverseViewport)

Methods inherited from class com.illumon.iris.db.v2.QueryTable

absSumBy, aj, apply, applyToAllBy, avgBy, by, byExternal, copy, copy, countBy, disableParallelWhereForThread, disableWriteReplace, dropColumns, enableWriteReplace, exactJoin, firstBy, flatten, getColumn, getColumnSource, getColumnSourceMap, getColumnSources, getDataIndex, getIndex, getModifiedColumnSetForUpdates, getRecord, getSubTable, getSubTable, head, headBy, headPct, isFlat, join, lastBy, lazyUpdate, leftJoin, maxBy, medianBy, memoizeResult, minBy, naturalJoin, newModifiedColumnSet, newModifiedColumnSetIdentityTransformer, newModifiedColumnSetIdentityTransformer, newModifiedColumnSetTransformer, preemptiveSnapshotTable, preemptiveUpdatesTable, preemptiveUpdatesTable, raj, releaseCachedResources, renameColumns, reverse, rollup, select, selectDistinct, setDataIndexProvider, setFlat, setMemoizeResults, silent, size, slice, snapshot, snapshotHistory, snapshotIncremental, sort, stdBy, sumBy, tail, tailBy, tailPct, treeTable, ungroup, update, updateBy, updateView, validateSelect, varBy, view, wavgBy, where, whereIn, wouldMatch, wsumBy

Methods inherited from class com.illumon.iris.db.v2.BaseTable

addParentReference, append, awaitUpdate, awaitUpdate, clearSortingRestrictions, copyAttributes, copyAttributes, createSwapListenerIfRefreshing, getAttributeNames, getAttributes, getDefinition, getDescription, getLastNotificationStep, hasAttribute, initializeWithSnapshot, isAddOnly, isAddOnly, isFailed, isRefreshing, isSystemicObject, layoutHints, listenForDirectUpdates, listenForUpdates, listenForUpdates, markSystemic, notifyListeners, notifyListenersOnError, removeDirectUpdateListener, removeUpdateListener, removeUpdateListener, restrictSortTo, satisfied, setAttribute, setColumnRenderers, setLastNotificationStep, setRefreshing, setTotalsTable, shouldCopyAttribute, toString, withColumnDescription, withKeys, withTableDescription, withUniqueKeys

Methods inherited from class com.illumon.iris.db.util.liveness.LivenessArtifact

manageWithCurrentScope, unmanage, unmanage

Methods inherited from class com.illumon.iris.db.util.liveness.ReferenceCountedLivenessNode

dropReference, getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryRetainReference

Methods inherited from class com.illumon.util.referencecounting.ReferenceCounted

decrementReferenceCount, 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 com.illumon.iris.db.v2.DynamicTable

listenForUpdates, newModifiedColumnSetTransformer, newModifiedColumnSetTransformer, notifyListeners

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessManager

manage, tryManage

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Methods inherited from interface com.illumon.iris.db.util.LongSizedDataStructure

intSize, intSize

Methods inherited from interface com.illumon.iris.db.tables.Table

absSumBy, absSumBy, absSumBy, aj, aj, aj, aj, aj, applyToAllBy, applyToAllBy, applyToAllBy, avgBy, avgBy, avgBy, by, by, by, by, by, by, byExternal, byteColumnIterator, characterColumnIterator, close, coalesce, columnIterator, countBy, countBy, countBy, dateTimeColumnAsNanos, dateTimeColumnAsNanos, deflate, deflate, doubleColumnIterator, dropColumnFormats, dropColumns, exactJoin, exactJoin, exactJoin, exactJoin, firstBy, firstBy, firstBy, floatColumnIterator, formatColumns, formatColumnWhere, formatRowWhere, getAttributes, getColumn, getColumns, getColumnSource, getMeta, getViewPort, hasColumns, hasColumns, headBy, headBy, integerColumnIterator, isEmpty, isLive, join, join, join, join, join, join, join, join, join, lastBy, lastBy, lastBy, layoutHints, lazyUpdate, lazyUpdate, leftJoin, leftJoin, leftJoin, leftJoin, leftJoin, longColumnIterator, maxBy, maxBy, maxBy, medianBy, medianBy, medianBy, minBy, minBy, minBy, moveColumns, moveColumns, moveDownColumns, moveUpColumns, naturalJoin, naturalJoin, naturalJoin, naturalJoin, preemptiveSnapshotTable, raj, raj, raj, raj, raj, renameAllColumns, renameColumns, renameColumns, rollup, rollup, rollup, rollup, rollup, rollup, rollup, select, select, select, selectDistinct, selectDistinct, selectDistinct, shortColumnIterator, sizeForInstrumentation, snapshot, snapshotIncremental, sort, sort, sortDescending, sortDescending, stdBy, stdBy, stdBy, subscribeToPreemptiveUpdates, sumBy, sumBy, sumBy, supportsPreemptiveSubscription, tailBy, tailBy, ungroup, ungroup, ungroup, ungroupAllBut, update, update, updateBy, updateBy, updateBy, updateBy, updateBy, updateView, updateView, validateSelect, varBy, varBy, varBy, view, view, wavgBy, wavgBy, wavgBy, where, where, where, whereIn, whereIn, whereIn, whereNotIn, whereNotIn, whereOneOf, whereOneOf, whereOneOf, withColumnDescription, wouldMatch, wsumBy, wsumBy, wsumBy

Field Details

DEBUG_ENABLED

public static final boolean DEBUG_ENABLED

BATCH_SIZE

protected static final int BATCH_SIZE

See Also:

• Constant Field Values

BARRAGE_PERFORMANCE_KEY_ATTRIBUTE

public static final String BARRAGE_PERFORMANCE_KEY_ATTRIBUTE

Set this attribute to enable collection of barrage performance stats.

See Also:

• Constant Field Values

stats

protected final BarrageTable.Stats stats

capacity

protected long capacity

the capacity that the destSources been set to

destSources

protected final WritableSource<?>[] destSources

the reinterpreted destination writable sources

Constructor Details

BarrageTable

protected BarrageTable(LiveTableRegistrar registrar,
 NotificationQueue notificationQueue,
 @Nullable
 @Nullable ScheduledExecutorService executorService,
 LinkedHashMap<String,ColumnSource> columns,
 WritableSource[] writableSources,
 Map<String,Object> attributes,
 @Nullable
 @Nullable BarrageTable.ViewportChangedCallback viewportChangedCallback)

Method Details

addSourceToRegistrar

public void addSourceToRegistrar()

Add this table to the registrar so that it can be refreshed.

ImplNote:

this cannot be performed in the constructor as the class is subclassed.

applyUpdates

protected abstract ShiftAwareListener.Update applyUpdates(ArrayDeque<BarrageMessage> localPendingUpdates)

getWireChunkTypes

public ChunkType[] getWireChunkTypes()

getWireTypes

public Class<?>[] getWireTypes()

getWireComponentTypes

public Class<?>[] getWireComponentTypes()

getServerViewport

@VisibleForTesting
public Index getServerViewport()

getServerReverseViewport

@VisibleForTesting
public boolean getServerReverseViewport()

getServerColumns

@VisibleForTesting
public BitSet getServerColumns()

handleBarrageMessage

public void handleBarrageMessage(BarrageMessage update)

Specified by:

handleBarrageMessage in interface BarrageMessage.Listener

handleBarrageError

public void handleBarrageError(Throwable t)

Specified by:

handleBarrageError in interface BarrageMessage.Listener

updateServerViewport

protected void updateServerViewport(Index viewport,
 BitSet columns,
 boolean reverseViewport)

isSubscribedColumn

protected boolean isSubscribedColumn(int i)

getNotificationQueue

protected NotificationQueue getNotificationQueue()

Description copied from class: BaseTable

Get the notification queue to insert notifications into as they are generated by listeners during DynamicTable.notifyListeners(Index, Index, Index). This method may be overridden to provide a different notification queue than the LiveTableMonitor.DEFAULT instance for more complex behavior.

Overrides:

getNotificationQueue in class BaseTable

Returns:

The NotificationQueue to add to.

make

@InternalUseOnly
public static BarrageTable make(@Nullable
 @Nullable ScheduledExecutorService executorService,
 TableDefinition tableDefinition,
 Map<String,Object> attributes,
 @Nullable
 @Nullable BarrageTable.ViewportChangedCallback vpCallback)

Set up a replicated table from the given proxy, id and columns. This is intended for internal use only.

Parameters:

executorService - an executor service used to flush stats

tableDefinition - the table definition

attributes - Key-Value pairs of attributes to forward to the QueryTable's metadata

Returns:

a properly initialized BarrageTable

make

@VisibleForTesting
public static BarrageTable make(@NotNull
 @NotNull LiveTableRegistrar registrar,
 @NotNull
 @NotNull NotificationQueue queue,
 @Nullable
 @Nullable ScheduledExecutorService executor,
 @NotNull
 @NotNull TableDefinition tableDefinition,
 @NotNull
 @NotNull Map<String,Object> attributes,
 @Nullable
 @Nullable BarrageTable.ViewportChangedCallback vpCallback)

makeColumns

@NotNull
protected static @NotNull LinkedHashMap<String,ColumnSource> makeColumns(@NotNull
 @NotNull List<ColumnDefinition> columns,
 @NotNull
 @NotNull WritableSource<?>[] writableSources,
 @NotNull
 @NotNull RedirectionIndex emptyRowRedirection)

Set up the columns for the replicated redirected table.

ApiNote:

emptyRowRedirection must be initialized and empty.

makeColumns

@NotNull
protected static @NotNull LinkedHashMap<String,ColumnSource> makeColumns(List<ColumnDefinition> columns,
 WritableSource<?>[] writableSources)

Set up the columns for the replicated blink table.

saveForDebugging

protected void saveForDebugging(BarrageMessage snapshotOrDelta)

maybeEnablePrevTracking

protected boolean maybeEnablePrevTracking()

doWakeup

protected void doWakeup()

getAttribute

@Nullable
public @Nullable Object getAttribute(@NotNull
 @NotNull String key)

Description copied from interface: Table

Get the value of the specified attribute.

Specified by:

getAttribute in interface Table

Overrides:

getAttribute in class BaseTable

Parameters:

key - the name of the attribute

Returns:

the value, or null if there was none.

beginLog

protected com.fishlib.io.log.LogEntry beginLog(@NotNull
 @NotNull com.fishlib.io.log.LogLevel level)

Convenience method for writing consistent log messages from this object.

Parameters:

level - the log level

Returns:

a LogEntry

destroy

protected void destroy()

Description copied from class: ReferenceCountedLivenessNode

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 BaseTable

getDeserializationTmConsumer

public LongConsumer getDeserializationTmConsumer()

recordMetric

protected void recordMetric(Function<BarrageTable.Stats,org.HdrHistogram.Histogram> hist,
 long value)