Package io.deephaven.engine.table.impl.hierarchical

Class RollupTableImpl

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

io.deephaven.engine.table.impl.hierarchical.RollupTableImpl

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, AttributeMap<RollupTable>, GridAttributes<RollupTable>, HierarchicalTable<RollupTable>, RollupTable, Serializable

public class RollupTableImpl
extends BaseGridAttributes<IFACE_TYPE,IMPL_TYPE>
implements RollupTable

RollupTable implementation.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.engine.table.hierarchical.HierarchicalTable

HierarchicalTable.SnapshotState

Nested classes/interfaces inherited from interface io.deephaven.engine.table.hierarchical.RollupTable

RollupTable.NodeOperationsRecorder, RollupTable.NodeType

Field Summary

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.hierarchical.HierarchicalTable

KEY_TABLE_ACTION_CONTRACT, KEY_TABLE_ACTION_EXPAND, KEY_TABLE_ACTION_EXPAND_ALL

Method Summary

Modifier and Type	Method	Description
protected final void	checkAvailableColumns(@NotNull Collection<String> columns)	Check this grid to ensure that all columns are present.
protected RollupTableImpl	copy()	Create a copy of this with initially-shared LiveAttributeMap.mutableAttributes.
Collection<? extends Aggregation>	getAggregations()	Get the aggregations for the rollup operation.
List<ColumnDefinition<?>>	getAvailableColumnDefinitions()	Get the definitions for all available columns that may be requested in a snapshot.
String	getDescription()	Get a description of this HierarchicalTable.
Table	getEmptyExpansionsTable()	Get a re-usable, static key Table with zero rows that will cause a snapshot to expand only the default nodes.
Collection<? extends ColumnName>	getGroupByColumns()	Get the group-by columns for the rollup operation.
TableDefinition	getNodeDefinition(@NotNull RollupTable.NodeType nodeType)	Get the TableDefinition that should be exposed to node table consumers, e.g.
Table	getRoot()	Get the root Table that represents the top level of this HierarchicalTable.
ColumnName	getRowDepthColumn()	Get the name of a column that denotes row depth.
ColumnName	getRowExpandedColumn()	Get the name of a column of Booleans that denotes whether a row is expanded (or expandable).
Table	getSource()	Get the source Table that was aggregated to make this HierarchicalTable.
List<ColumnDefinition<?>>	getStructuralColumnDefinitions()	Get the definitions for all structural columns.
boolean	includesConstituents()	Are the source table's constituent rows included at the lowest level of the rollup?
static WhereFilter[]	initializeAndValidateFilters(@NotNull Table source, @NotNull Collection<? extends ColumnName> groupByColumns, @NotNull Collection<? extends Filter> filters, @NotNull Function<String,? extends RuntimeException> exceptionFactory)	Initialize and validate the supplied filters for this RollupTable.
io.deephaven.engine.table.impl.hierarchical.RollupNodeOperationsRecorder	makeNodeOperationsRecorder(@NotNull RollupTable.NodeType nodeType)	Get a recorder for per-node operations to apply during snapshots of the requested RollupTable.NodeType.
static RollupTable	makeRollup(@NotNull QueryTable source, @NotNull Collection<? extends Aggregation> aggregations, boolean includeConstituents, @NotNull Collection<? extends ColumnName> groupByColumns)
HierarchicalTable.SnapshotState	makeSnapshotState()	Make a re-usable snapshot state.
long	snapshot(HierarchicalTable.SnapshotState snapshotState, @NotNull Table keyTable, @Nullable ColumnName keyTableActionColumn, @Nullable BitSet columns, @NotNull RowSequence rows, @NotNull WritableChunk<? super Values>[] destinations)	Take a snapshot of the data in the grid defined by columns, rows, and the directives in keyTable.
RollupTable.NodeOperationsRecorder	translateAggregatedNodeOperationsForConstituentNodes(@NotNull RollupTable.NodeOperationsRecorder aggregatedNodeOperationsToTranslate)	Translate node operations for aggregated nodes to the closest equivalent for a constituent node.
RollupTable	withFilter(@NotNull Filter filter)	Apply a filter to the group-by columns of this RollupTable in order to produce a new RollupTable.
RollupTable	withNodeOperations(@NotNull RollupTable.NodeOperationsRecorder... nodeOperations)	Get a new RollupTable that will apply the recorded operations to nodes when gathering snapshots.

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

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

destroy, dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, 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.table.hierarchical.HierarchicalTable

getRoot, getRowDepthColumn, getRowExpandedColumn, getSource, getStructuralColumnDefinitions, makeSnapshotState, snapshot

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage, unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Methods inherited from interface io.deephaven.engine.table.hierarchical.RollupTable

getLeafNodeType

Method Details

getAggregations

public Collection<? extends Aggregation> getAggregations()

Description copied from interface: RollupTable

Get the aggregations for the rollup operation.

Specified by:

getAggregations in interface RollupTable

Returns:

The rollup aggregations

includesConstituents

public boolean includesConstituents()

Description copied from interface: RollupTable

Are the source table's constituent rows included at the lowest level of the rollup?

Specified by:

includesConstituents in interface RollupTable

Returns:

Whether constituents are included

getGroupByColumns

public Collection<? extends ColumnName> getGroupByColumns()

Description copied from interface: RollupTable

Get the group-by columns for the rollup operation.

Specified by:

getGroupByColumns in interface RollupTable

Returns:

The group-by columns

getDescription

public String getDescription()

Description copied from interface: HierarchicalTable

Get a description of this HierarchicalTable.

Specified by:

getDescription in interface HierarchicalTable<RollupTable>

Returns:

The description

getEmptyExpansionsTable

public Table getEmptyExpansionsTable()

Description copied from interface: HierarchicalTable

Get a re-usable, static key Table with zero rows that will cause a snapshot to expand only the default nodes.

Specified by:

getEmptyExpansionsTable in interface HierarchicalTable<RollupTable>

Returns:

An empty key Table for default expansions

getNodeDefinition

public TableDefinition getNodeDefinition(@NotNull
 @NotNull RollupTable.NodeType nodeType)

Description copied from interface: RollupTable

Get the TableDefinition that should be exposed to node table consumers, e.g. UI-driven snapshots. This excludes "internal" columns used to organize the rollup or support operations, as well as the row-depth column and row-expanded column, but includes formatting columns.

Specified by:

getNodeDefinition in interface RollupTable

Parameters:

nodeType - The node type to get the TableDefinition for

Returns:

The externally-visible node TableDefinition for the requested nodeType

getAvailableColumnDefinitions

public List<ColumnDefinition<?>> getAvailableColumnDefinitions()

Description copied from interface: HierarchicalTable

Get the definitions for all available columns that may be requested in a snapshot.

The result will always begin with the structural columns, which are then followed by type-specific node-level columns.

Specified by:

getAvailableColumnDefinitions in interface HierarchicalTable<RollupTable>

Returns:

A list of definitions for all available columns that may be requested in a snapshot

withFilter

public RollupTable withFilter(@NotNull
 @NotNull Filter filter)

Description copied from interface: RollupTable

Apply a filter to the group-by columns of this RollupTable in order to produce a new RollupTable.

Specified by:

withFilter in interface RollupTable

Parameters:

filter - The filter to apply; must only reference the group-by columns and must not use column arrays

Returns:

The new RollupTable

initializeAndValidateFilters

public static WhereFilter[] initializeAndValidateFilters(@NotNull
 @NotNull Table source,
 @NotNull
 @NotNull Collection<? extends ColumnName> groupByColumns,
 @NotNull
 @NotNull Collection<? extends Filter> filters,
 @NotNull
 @NotNull Function<String,? extends RuntimeException> exceptionFactory)

Initialize and validate the supplied filters for this RollupTable.

Parameters:

source - The rollup source

groupByColumns - The rollup group-by columns

filters - The filters to initialize and validate

exceptionFactory - A factory for creating exceptions from their messages

Returns:

The initialized and validated filters

makeNodeOperationsRecorder

public io.deephaven.engine.table.impl.hierarchical.RollupNodeOperationsRecorder makeNodeOperationsRecorder(@NotNull
 @NotNull RollupTable.NodeType nodeType)

Description copied from interface: RollupTable

Get a recorder for per-node operations to apply during snapshots of the requested RollupTable.NodeType.

Specified by:

makeNodeOperationsRecorder in interface RollupTable

Parameters:

nodeType - The node type that operations will be applied to

Returns:

The new recorder

withNodeOperations

public RollupTable withNodeOperations(@NotNull
 @NotNull RollupTable.NodeOperationsRecorder... nodeOperations)

Description copied from interface: RollupTable

Get a new RollupTable that will apply the recorded operations to nodes when gathering snapshots. Operations will be applied only to the node type supplied when the elements of nodeOperations were initially created.

Specified by:

withNodeOperations in interface RollupTable

Parameters:

nodeOperations - The node-level operations to apply. Elements must have been initially supplied by RollupTable.makeNodeOperationsRecorder(NodeType) from this RollupTable.

Returns:

The new RollupTable

translateAggregatedNodeOperationsForConstituentNodes

public RollupTable.NodeOperationsRecorder translateAggregatedNodeOperationsForConstituentNodes(@NotNull
 @NotNull RollupTable.NodeOperationsRecorder aggregatedNodeOperationsToTranslate)

Description copied from interface: RollupTable

Translate node operations for aggregated nodes to the closest equivalent for a constituent node. May only be invoked if includesConstituents() == true.

Specified by:

translateAggregatedNodeOperationsForConstituentNodes in interface RollupTable

Parameters:

aggregatedNodeOperationsToTranslate - Node-level operations for aggregated nodes, initially supplied by makeNodeOperationsRecorder(NodeType.Aggregated).

Returns:

Node-level operations for constituent nodes

copy

protected RollupTableImpl copy()

Description copied from class: LiveAttributeMap

Create a copy of this with initially-shared LiveAttributeMap.mutableAttributes.

Specified by:

copy in class LiveAttributeMap<RollupTable,RollupTableImpl>

makeRollup

public static RollupTable makeRollup(@NotNull
 @NotNull QueryTable source,
 @NotNull
 @NotNull Collection<? extends Aggregation> aggregations,
 boolean includeConstituents,
 @NotNull
 @NotNull Collection<? extends ColumnName> groupByColumns)

getSource

public Table getSource()

Description copied from interface: HierarchicalTable

Get the source Table that was aggregated to make this HierarchicalTable.

Specified by:

getSource in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

Returns:

The source table

getRoot

public Table getRoot()

Description copied from interface: HierarchicalTable

Get the root Table that represents the top level of this HierarchicalTable.

Specified by:

getRoot in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

Returns:

The root table

getRowExpandedColumn

public ColumnName getRowExpandedColumn()

Description copied from interface: HierarchicalTable

Get the name of a column of Booleans that denotes whether a row is expanded (or expandable). It takes on the value null for rows that are not expandable, false for expandable but unexpanded rows, and true for expanded rows. This column is "synthetic"; that is, it's not part of the data, but rather calculated as part of snapshotting.

Specified by:

getRowExpandedColumn in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

Returns:

The name of a column that denotes whether a row is expanded or expandable

getRowDepthColumn

public ColumnName getRowDepthColumn()

Description copied from interface: HierarchicalTable

Get the name of a column that denotes row depth. This column is "synthetic"; that is, it's not part of the data, but rather calculated as part of snapshotting.

Specified by:

getRowDepthColumn in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

Returns:

The name of a column that denotes row depth

getStructuralColumnDefinitions

public List<ColumnDefinition<?>> getStructuralColumnDefinitions()

Description copied from interface: HierarchicalTable

Get the definitions for all structural columns. Structural columns are synthetic columns that allow snapshot consumers to make sense of the relationship between rows, and should always be included in the requested columns set when snapshotting a HierarchicalTable. This list includes the row-depth column and the row-expanded column, but never includes type-specific node-level columns.

Specified by:

getStructuralColumnDefinitions in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

Returns:

A list of @link ColumnDefinition definitions} for all structural columns

makeSnapshotState

public HierarchicalTable.SnapshotState makeSnapshotState()

Description copied from interface: HierarchicalTable

Make a re-usable snapshot state. The result will ensure liveness for this HierarchicalTable if the source isRefreshing, and callers must similarly retain the result for the duration of their usage under the same conditions.

Specified by:

makeSnapshotState in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

checkAvailableColumns

protected final void checkAvailableColumns(@NotNull
 @NotNull Collection<String> columns)

Description copied from class: BaseGridAttributes

Check this grid to ensure that all columns are present.

Specified by:

checkAvailableColumns in class BaseGridAttributes<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>,IMPL_TYPE extends io.deephaven.engine.table.impl.hierarchical.HierarchicalTableImpl<IFACE_TYPE,IMPL_TYPE>>

Parameters:

columns - The column names to check

snapshot

public long snapshot(@NotNull
 HierarchicalTable.SnapshotState snapshotState,
 @NotNull
 @NotNull Table keyTable,
 @Nullable
 @Nullable ColumnName keyTableActionColumn,
 @Nullable
 @Nullable BitSet columns,
 @NotNull
 @NotNull RowSequence rows,
 @NotNull
 @NotNull WritableChunk<? super Values>[] destinations)

Description copied from interface: HierarchicalTable

Take a snapshot of the data in the grid defined by columns, rows, and the directives in keyTable. Accumulate the results in destinations.

Specified by:

snapshot in interface HierarchicalTable<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>>

Parameters:

snapshotState - Snapshot state object used to cache data across invocations. Must have been created by this HierarchicalTable with HierarchicalTable.makeSnapshotState().

keyTable - Type-specific "key" table specifying expanded and contracted nodes

keyTableActionColumn - The name of a column of byte on keyTable that specifies whether nodes should be expanded, expanded with their descendants, or contracted. If null, all rows are treated as simple expansions.

columns - Optional bit-set of columns to include, null to include all columns

rows - Position-space rows to include from the expanded data specified by keyTable

destinations - The destination chunks

Returns:

The total expanded data size or an estimate thereof