Package io.deephaven.engine.table.impl

Class SourceTable<IMPL_TYPE extends SourceTable<IMPL_TYPE>>

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.LiveAttributeMap<IFACE_TYPE,IMPL_TYPE>

io.deephaven.engine.table.impl.BaseGridAttributes<Table,IMPL_TYPE>

io.deephaven.engine.table.impl.BaseTable<IMPL_TYPE>

io.deephaven.engine.table.impl.UncoalescedTable<IMPL_TYPE>

io.deephaven.engine.table.impl.RedefinableTable<IMPL_TYPE>

io.deephaven.engine.table.impl.SourceTable<IMPL_TYPE>

All Implemented Interfaces:

TableOperations<Table,Table>, TableOperationsDefaults<Table,Table>, LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, AttributeMap<Table>, GridAttributes<Table>, HasParentPerformanceIds, HasRefreshingSource, NotificationStepReceiver, NotificationStepSource, TableDefaults, Table, DynamicNode, NotificationQueue.Dependency, SystemicObject<Table>, LongSizedDataStructure, Serializable

Direct Known Subclasses:

PartitionAwareSourceTable, SimpleSourceTable

public abstract class SourceTable<IMPL_TYPE extends SourceTable<IMPL_TYPE>>
extends RedefinableTable<IMPL_TYPE>
implements HasRefreshingSource

Basic uncoalesced table that only adds keys.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.BaseTable

BaseTable.CopyAttributeOperation, BaseTable.ListenerImpl, BaseTable.ShiftObliviousListenerImpl, BaseTable.SnapshotControlFactory<T extends ConstructSnapshot.SnapshotControl>

Field Summary

Fields inherited from class io.deephaven.engine.table.impl.BaseTable

definition, PRINT_SERIALIZED_UPDATE_OVERLAPS, updateGraph, VALIDATE_UPDATE_OVERLAPS

Fields inherited from interface io.deephaven.engine.table.GridAttributes

COLUMN_DESCRIPTIONS_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, LAYOUT_HINTS_ATTRIBUTE, SORTABLE_COLUMNS_ATTRIBUTE

Fields inherited from interface io.deephaven.engine.table.impl.NotificationStepReceiver

NULL_NOTIFICATION_STEP

Fields inherited from interface io.deephaven.engine.table.Table

ADD_ONLY_TABLE_ATTRIBUTE, AGGREGATION_ROW_LOOKUP_ATTRIBUTE, APPEND_ONLY_TABLE_ATTRIBUTE, BARRAGE_PERFORMANCE_KEY_ATTRIBUTE, BARRAGE_SCHEMA_ATTRIBUTE, BLINK_TABLE_ATTRIBUTE, FILTERABLE_COLUMNS_ATTRIBUTE, INITIALLY_EMPTY_COALESCED_SOURCE_TABLE_ATTRIBUTE, INPUT_TABLE_ATTRIBUTE, KEY_COLUMNS_ATTRIBUTE, MERGED_TABLE_ATTRIBUTE, NON_DISPLAY_TABLE, PLUGIN_NAME, PREVIEW_PARENT_TABLE, SNAPSHOT_VIEWPORT_TYPE, SORT_REVERSE_LOOKUP_ATTRIBUTE, SORT_ROW_REDIRECTION_ATTRIBUTE, SORTED_COLUMNS_ATTRIBUTE, SYSTEMIC_TABLE_ATTRIBUTE, TEST_SOURCE_TABLE_ATTRIBUTE, TOTALS_TABLE_ATTRIBUTE, UNIQUE_KEYS_ATTRIBUTE

Fields inherited from interface io.deephaven.engine.table.impl.TableDefaults

ZERO_LENGTH_TABLE_ARRAY

Fields inherited from interface io.deephaven.api.TableOperations

AGG_BY_PRESERVE_EMPTY_DEFAULT

Fields inherited from interface io.deephaven.api.TableOperationsDefaults

ZERO_LENGTH_COLUMNNAME_ARRAY, ZERO_LENGTH_FILTER_ARRAY

Method Summary

Modifier and Type	Method	Description
protected void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
protected final QueryTable	doCoalesce()	Produce the actual coalesced result table, suitable for caching.
protected Collection<LiveSupplier<ImmutableTableLocationKey>>	filterLocationKeys(@NotNull Collection<LiveSupplier<ImmutableTableLocationKey>> foundLocationKeys)	Hook to allow found location keys to be filtered (e.g.
TrackingRowSet	getRowSet()
protected final void	initialize()	Force this table to determine its initial state (available locations, size, RowSet) if it hasn't already done so.
final void	refresh()	This is only for unit tests, at this time.
@NotNull Stream<PerformanceEntry>	sourceEntries()	Return a stream of performance entries that represent the InstrumentedTableUpdateSource which drive this table.
final TableLocationProvider	tableLocationProvider()

Methods inherited from class io.deephaven.engine.table.impl.RedefinableTable

dropColumns, redefine, redefine, renameColumns, updateView, view

Methods inherited from class io.deephaven.engine.table.impl.UncoalescedTable

addUpdateListener, addUpdateListener, addUpdateListener, addUpdateListenerUncoalesced, addUpdateListenerUncoalesced, aggAllBy, aggBy, apply, asOfJoin, awaitUpdate, awaitUpdate, byteColumnIterator, characterColumnIterator, coalesce, columnIterator, doubleColumnIterator, exactJoin, flatten, floatColumnIterator, getCoalesced, getColumnSource, getColumnSourceMap, getColumnSources, getSubTable, head, headBy, headPct, integerColumnIterator, isFlat, join, lazyUpdate, longColumnIterator, moveColumns, naturalJoin, objectColumnIterator, objectColumnIterator, partitionBy, partitionedAggBy, rangeJoin, removeUpdateListener, removeUpdateListener, removeUpdateListenerUncoalesced, reverse, rollup, select, selectDistinct, setCoalesced, shortColumnIterator, size, sizeForInstrumentation, slice, slicePct, snapshot, snapshotWhen, sort, tail, tailBy, tailPct, tree, ungroup, update, updateBy, where, whereIn, whereNotIn, wouldMatch

Methods inherited from class io.deephaven.engine.table.impl.BaseTable

addParentReference, append, assertAddOnly, assertAppendOnly, assertBlink, checkAvailableColumns, copyAttributes, copyAttributes, copySortableColumns, createSnapshotControlIfRefreshing, getDefinition, getDescription, getLastNotificationStep, getNotificationQueue, getUpdateGraph, hasListeners, initializeWithSnapshot, isAddOnly, isAppendOnly, isBlink, isFailed, isRefreshing, isSystemicObject, markSystemic, notifyListeners, notifyListeners, notifyListenersOnError, parentPerformanceEntryIds, removeBlink, satisfied, setLastNotificationStep, setRefreshing, setTotalsTable, shouldCopyAttribute, toString, withKeys, withUniqueKeys

Methods inherited from class io.deephaven.engine.table.impl.BaseGridAttributes

clearSortingRestrictions, getSortableColumns, restrictSortTo, setColumnDescriptions, setLayoutHints, setSortableColumns, withColumnDescription, withColumnDescriptions, withDescription

Methods inherited from class io.deephaven.engine.table.impl.LiveAttributeMap

copy, copyAttributes, getAttribute, getAttributeKeys, getAttributes, getAttributes, hasAttribute, prepareReturnCopy, prepareReturnThis, published, retainingAttributes, setAttribute, setAttribute, withAttributes, withAttributes, withoutAttributes

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.table.AttributeMap

getAttribute, getAttributeKeys, getAttributes, getAttributes, hasAttribute, retainingAttributes, withAttributes, withAttributes, withoutAttributes

Methods inherited from interface io.deephaven.engine.table.GridAttributes

clearSortingRestrictions, restrictSortTo, setLayoutHints, withColumnDescription, withColumnDescriptions, withDescription

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.util.datastructures.LongSizedDataStructure

intSize, intSize

Methods inherited from interface io.deephaven.engine.updategraph.NotificationQueue.Dependency

getUpdateGraph

Methods inherited from interface io.deephaven.engine.table.impl.NotificationStepReceiver

initializeLastNotificationStep

Methods inherited from interface io.deephaven.engine.table.impl.TableDefaults

addUpdateListener, applyToAllBy, applyToAllBy, applyToAllBy, close, dropColumnFormats, formatColumns, formatColumnWhere, formatRowWhere, getColumnSource, getColumnSource, hasColumns, hasColumns, headBy, isEmpty, join, meta, moveColumnsDown, moveColumnsUp, numColumns, partitionBy, releaseCachedResources, renameAllColumns, renameColumns, rollup, rollup, rollup, rollup, rollup, selectDistinct, snapshotWhen, snapshotWhen, tailBy, wouldMatch

Methods inherited from interface io.deephaven.api.TableOperationsDefaults

absSumBy, absSumBy, absSumBy, absSumBy, aggAllBy, aggAllBy, aggAllBy, aggBy, aggBy, aggBy, aggBy, aggBy, aggBy, aggBy, aj, aj, avgBy, avgBy, avgBy, avgBy, countBy, countBy, countBy, countBy, dropColumns, dropColumns, exactJoin, exactJoin, firstBy, firstBy, firstBy, firstBy, groupBy, groupBy, groupBy, join, join, join, lastBy, lastBy, lastBy, lastBy, lazyUpdate, maxBy, maxBy, maxBy, maxBy, medianBy, medianBy, medianBy, medianBy, minBy, minBy, minBy, minBy, naturalJoin, naturalJoin, naturalJoin, naturalJoin, naturalJoin, raj, raj, rangeJoin, select, select, selectDistinct, sort, sortDescending, stdBy, stdBy, stdBy, stdBy, sumBy, sumBy, sumBy, sumBy, ungroup, ungroup, ungroup, ungroup, update, updateBy, updateBy, updateBy, updateBy, updateBy, updateBy, updateBy, updateBy, updateView, varBy, varBy, varBy, varBy, view, wavgBy, wavgBy, wavgBy, wavgBy, where, whereIn, whereNotIn, wsumBy, wsumBy, wsumBy, wsumBy

Method Details

initialize

protected final void initialize()

Force this table to determine its initial state (available locations, size, RowSet) if it hasn't already done so.

tableLocationProvider

@TestUseOnly
public final TableLocationProvider tableLocationProvider()

refresh

@TestUseOnly
public final void refresh()

This is only for unit tests, at this time.

filterLocationKeys

protected Collection<LiveSupplier<ImmutableTableLocationKey>> filterLocationKeys(@NotNull
 @NotNull Collection<LiveSupplier<ImmutableTableLocationKey>> foundLocationKeys)

Hook to allow found location keys to be filtered (e.g. according to a where-clause on the partitioning columns of a PartitionAwareSourceTable. The default implementation returns its input unmolested.

Parameters:

foundLocationKeys - A collection of ImmutableTableLocationKeys fetched from the TableLocationProvider, but not yet incorporated into the table

Returns:

A sub-collection of the input

doCoalesce

protected final QueryTable doCoalesce()

Description copied from class: UncoalescedTable

Produce the actual coalesced result table, suitable for caching.

Note that if this table must have listeners registered, etc, setting these up is the implementation's responsibility.

Also note that the implementation should copy attributes, as in copyAttributes(resultTable, CopyAttributeOperation.Coalesce).

Specified by:

doCoalesce in class UncoalescedTable<IMPL_TYPE extends SourceTable<IMPL_TYPE>>

Returns:

The coalesced result table, suitable for caching

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 BaseTable<IMPL_TYPE extends SourceTable<IMPL_TYPE>>

sourceEntries

@NotNull
public @NotNull Stream<PerformanceEntry> sourceEntries()

Description copied from interface: HasRefreshingSource

Return a stream of performance entries that represent the InstrumentedTableUpdateSource which drive this table.

If no such sources, exist, then an empty stream is returned.

Specified by:

sourceEntries in interface HasRefreshingSource

Returns:

a stream of performance entries for this node in the graph

getRowSet

public TrackingRowSet getRowSet()

Specified by:

getRowSet in interface Table

Overrides:

getRowSet in class UncoalescedTable<IMPL_TYPE extends SourceTable<IMPL_TYPE>>

Returns:

The TrackingRowSet that exposes the row keys present in this Table