Package io.deephaven.server.hierarchicaltable

Class HierarchicalTableView

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.server.hierarchicaltable.HierarchicalTableView
All Implemented Interfaces:
io.deephaven.base.log.LogOutputAppendable, io.deephaven.engine.liveness.LivenessManager, io.deephaven.engine.liveness.LivenessNode, io.deephaven.engine.liveness.LivenessReferent, Serializable
public final class HierarchicalTableView extends io.deephaven.engine.liveness.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:

  • Method Summary

    Modifier and Type
    Method
    Description
    io.deephaven.engine.table.hierarchical.HierarchicalTable<?>
    getHierarchicalTable()
     
    io.deephaven.engine.table.Table
    getKeyTable()
     
    io.deephaven.api.ColumnName
    getKeyTableActionColumn()
     
    io.deephaven.engine.table.hierarchical.HierarchicalTable.SnapshotState
    getSnapshotState()
     
    static HierarchicalTableView
    makeFromExistingView(@NotNull HierarchicalTableView existingView)
    Make a new HierarchicalTableView from an existing one, which will snapshot the existing view's HierarchicalTable with only the root expanded.
    static HierarchicalTableView
    makeFromExistingView(@NotNull HierarchicalTableView existingView, @NotNull io.deephaven.engine.table.Table keyTable, @Nullable io.deephaven.api.ColumnName keyTableActionColumn)
    Make a new HierarchicalTableView from an existing one, which will snapshot the existing view's HierarchicalTable according to the expansions described by keyTable.
    static HierarchicalTableView
    makeFromHierarchicalTable(@NotNull io.deephaven.engine.table.hierarchical.HierarchicalTable<?> hierarchicalTable)
    Make a new HierarchicalTableView that will snapshot hierarchicalTable with only the root expanded.
    static HierarchicalTableView
    makeFromHierarchicalTable(@NotNull io.deephaven.engine.table.hierarchical.HierarchicalTable<?> hierarchicalTable, @NotNull io.deephaven.engine.table.Table keyTable, @Nullable io.deephaven.api.ColumnName keyTableActionColumn)
    Make a new HierarchicalTableView that will snapshot hierarchicalTable according to the expansions described by keyTable.

    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

    • getHierarchicalTable

      public io.deephaven.engine.table.hierarchical.HierarchicalTable<?> getHierarchicalTable()

    • getSnapshotState

      public io.deephaven.engine.table.hierarchical.HierarchicalTable.SnapshotState getSnapshotState()

    • getKeyTable

      public io.deephaven.engine.table.Table getKeyTable()

    • getKeyTableActionColumn

      public io.deephaven.api.ColumnName getKeyTableActionColumn()

    • makeFromHierarchicalTable

      public static HierarchicalTableView makeFromHierarchicalTable(@NotNull @NotNull io.deephaven.engine.table.hierarchical.HierarchicalTable<?> hierarchicalTable, @NotNull @NotNull io.deephaven.engine.table.Table keyTable, @Nullable @Nullable io.deephaven.api.ColumnName keyTableActionColumn)
      Make a new HierarchicalTableView that will snapshot hierarchicalTable according to the expansions described by keyTable.
      Parameters:
      hierarchicalTable - The HierarchicalTable to snapshot
      keyTable - The Table to use for expansion key data
      keyTableActionColumn - The ColumnName of expansion actions, if other than expand.
      Returns:
      The new HierarchicalTableView, which will have a new snapshot state

    • makeFromHierarchicalTable

      public static HierarchicalTableView makeFromHierarchicalTable(@NotNull @NotNull io.deephaven.engine.table.hierarchical.HierarchicalTable<?> hierarchicalTable)
      Make a new HierarchicalTableView that will snapshot hierarchicalTable with only the root expanded.
      Parameters:
      hierarchicalTable - The HierarchicalTable to snapshot
      Returns:
      The new HierarchicalTableView, which will have a new snapshot state

    • makeFromExistingView

      public static HierarchicalTableView makeFromExistingView(@NotNull @NotNull HierarchicalTableView existingView, @NotNull @NotNull io.deephaven.engine.table.Table keyTable, @Nullable @Nullable io.deephaven.api.ColumnName keyTableActionColumn)
      Make a new HierarchicalTableView from an existing one, which will snapshot the existing view's HierarchicalTable according to the expansions described by keyTable.
      Parameters:
      existingView - The existing HierarchicalTableView
      keyTable - The Table to use for expansion key data
      keyTableActionColumn - The ColumnName of expansion actions, if other than expand.
      Returns:
      The new HierarchicalTableView, which will share snapshot state with existing

    • makeFromExistingView

      public static HierarchicalTableView makeFromExistingView(@NotNull @NotNull HierarchicalTableView existingView)
      Make a new HierarchicalTableView from an existing one, which will snapshot the existing view's HierarchicalTable with only the root expanded.
      Parameters:
      existingView - The existing HierarchicalTableView
      Returns:
      The new HierarchicalTableView, which will share snapshot state with existing