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

Class HierarchicalTableImpl<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>,IMPL_TYPE extends HierarchicalTableImpl<IFACE_TYPE,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<IFACE_TYPE,IMPL_TYPE>

io.deephaven.engine.table.impl.hierarchical.HierarchicalTableImpl<IFACE_TYPE,IMPL_TYPE>

All Implemented Interfaces:

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

Direct Known Subclasses:

RollupTableImpl, TreeTableImpl

public abstract class HierarchicalTableImpl<IFACE_TYPE extends HierarchicalTable<IFACE_TYPE>,IMPL_TYPE extends HierarchicalTableImpl<IFACE_TYPE,IMPL_TYPE>>
extends BaseGridAttributes<IFACE_TYPE,IMPL_TYPE>
implements HierarchicalTable<IFACE_TYPE>

Base result class for operations that produce hierarchical tables, for example rollup and tree.

See Also:

• Serialized Form

Nested Class Summary

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

HierarchicalTable.SnapshotState

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HierarchicalTableImpl(@NotNull Map<String,Object> initialAttributes, @NotNull QueryTable source, @NotNull QueryTable root)

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.
static void	checkRebaseDefinition(String type, @NotNull Table existingTable, @NotNull Table newSource)	Check that the table we are rebasing to has the same definition as the current table, producing a helpful error message.
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.
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.

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

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

getAvailableColumnDefinitions, getDescription, getEmptyExpansionsTable

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

Constructor Details

HierarchicalTableImpl

protected HierarchicalTableImpl(@NotNull
 @NotNull Map<String,Object> initialAttributes,
 @NotNull
 @NotNull QueryTable source,
 @NotNull
 @NotNull QueryTable root)

Method Details

checkRebaseDefinition

public static void checkRebaseDefinition(String type,
 @NotNull
 @NotNull Table existingTable,
 @NotNull
 @NotNull Table newSource)

Check that the table we are rebasing to has the same definition as the current table, producing a helpful error message.

Parameters:

type - the type of engine object that is being rebased

existingTable - the existing source table

newSource - the new source table

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