Package io.deephaven.pivot

Class PivotTableView

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.pivot.PivotTableView

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, Serializable

public final class PivotTableView
extends LivenessArtifact

Server-side "view" object representing a client's snapshot target for HierarchicalTable data.

Instances associate two different kinds of information to fully describe the view:

• The HierarchicalTable instance
• The key Table information to be used when snapshotting the HierarchicalTable

Instances also store re-usable snapshot states across snapshot invocations.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Table	getColumnKeyTable()
ColumnName	getColumnKeyTableActionColumn()
List<ColumnName>	getOutputColumns()
PivotTable	getPivotTable()
Table	getRowKeyTable()
ColumnName	getRowKeyTableActionColumn()
PivotTable.SnapshotState	getSnapshotState()
static PivotTableView	makeFromExistingView(@NotNull PivotTableView existingView)	Make a new PivotTableView from an existing one, which will snapshot the existing view's PivotTable with only the root expanded.
static PivotTableView	makeFromExistingView(@NotNull PivotTableView existingView, @NotNull Table rowKeyTable, @NotNull Table columnKeyTable, @Nullable ColumnName rowKeyTableActionColumn, @Nullable ColumnName columnKeyTableActionColumn, @NotNull List<ColumnName> outputColumns)	Make a new PivotTableView from an existing one, which will snapshot the existing view's PivotTable according to the expansions described by rowKeyTable and columnKeyTable.
static PivotTableView	makeFromPivotTable(@NotNull PivotTable pivotTable)	Make a new PivotTableView that will snapshot pivotTable with only the roots expanded.
static PivotTableView	makeFromPivotTable(@NotNull PivotTable pivotTable, @NotNull Table rowKeyTable, @NotNull Table columnKeyTable, @Nullable ColumnName rowKeyTableActionColumn, @Nullable ColumnName columnKeyTableActionColumn, @NotNull List<ColumnName> outputColumns)	Make a new PivotTableView that will snapshot pivotTable according to the expansions described by rowKeyTable and columnKeyTable.

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.liveness.LivenessManager

manage, unmanage, unmanage

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

dropReference, getReferentDescription, retainReference, tryRetainReference

Method Details

getPivotTable

public PivotTable getPivotTable()

getSnapshotState

public PivotTable.SnapshotState getSnapshotState()

getRowKeyTable

public Table getRowKeyTable()

getColumnKeyTable

public Table getColumnKeyTable()

getOutputColumns

public List<ColumnName> getOutputColumns()

getRowKeyTableActionColumn

public ColumnName getRowKeyTableActionColumn()

getColumnKeyTableActionColumn

public ColumnName getColumnKeyTableActionColumn()

makeFromPivotTable

public static PivotTableView makeFromPivotTable(@NotNull
 @NotNull PivotTable pivotTable,
 @NotNull
 @NotNull Table rowKeyTable,
 @NotNull
 @NotNull Table columnKeyTable,
 @Nullable
 @Nullable ColumnName rowKeyTableActionColumn,
 @Nullable
 @Nullable ColumnName columnKeyTableActionColumn,
 @NotNull
 @NotNull List<ColumnName> outputColumns)

Make a new PivotTableView that will snapshot pivotTable according to the expansions described by rowKeyTable and columnKeyTable.

Parameters:

pivotTable - The PivotTable to snapshot

rowKeyTable - The Table to use for row expansion key data

columnKeyTable - The Table to use for column expansion key data

rowKeyTableActionColumn - The ColumnName of row expansion actions, if other than expand.

columnKeyTableActionColumn - The ColumnName of column expansion actions, if other than expand.

outputColumns -

Returns:

The new PivotTableView, which will have a new snapshot state

makeFromPivotTable

public static PivotTableView makeFromPivotTable(@NotNull
 @NotNull PivotTable pivotTable)

Make a new PivotTableView that will snapshot pivotTable with only the roots expanded.

Parameters:

pivotTable - The PivotTable to snapshot

Returns:

The new HierarchicalTableView, which will have a new snapshot state

makeFromExistingView

public static PivotTableView makeFromExistingView(@NotNull
 @NotNull PivotTableView existingView,
 @NotNull
 @NotNull Table rowKeyTable,
 @NotNull
 @NotNull Table columnKeyTable,
 @Nullable
 @Nullable ColumnName rowKeyTableActionColumn,
 @Nullable
 @Nullable ColumnName columnKeyTableActionColumn,
 @NotNull
 @NotNull List<ColumnName> outputColumns)

Make a new PivotTableView from an existing one, which will snapshot the existing view's PivotTable according to the expansions described by rowKeyTable and columnKeyTable.

Parameters:

existingView - The existing PivotTable

rowKeyTable - The Table to use for row expansion key data

columnKeyTable - The Table to use for column expansion key data

rowKeyTableActionColumn - The ColumnName of row expansion actions, if other than expand.

columnKeyTableActionColumn - The ColumnName of column expansion actions, if other than expand.

Returns:

The new PivotTableView, which will share snapshot state with existing

makeFromExistingView

public static PivotTableView makeFromExistingView(@NotNull
 @NotNull PivotTableView existingView)

Make a new PivotTableView from an existing one, which will snapshot the existing view's PivotTable with only the root expanded.

Parameters:

existingView - The existing PivotTable

Returns:

The new PivotTableView, which will share snapshot state with existing