Package io.deephaven.engine.table

Interface GridAttributes<TYPE extends GridAttributes<TYPE>>

All Superinterfaces:
AttributeMap<TYPE>
All Known Subinterfaces:
HierarchicalTable<IFACE_TYPE>, IcebergTable, LazySnapshotTable, RollupTable, Table, TableAdapter, TableDefaults, TreeTable
All Known Implementing Classes:
AppendOnlyArrayBackedInputTable, BarrageBlinkTable, BarrageRedirectedTable, BarrageTable, BaseGridAttributes, BaseTable, DeferredViewTable, HierarchicalTableImpl, IcebergTableImpl, InMemoryTable, KeyedArrayBackedInputTable, PartitionAwareSourceTable, QueryReplayGroupedTable, QueryTable, QueryTable.FilteredTable, RedefinableTable, ReplayGroupedFullTable, ReplayLastByGroupedTable, ReplayTable, ReplayTableBase, RollupTableImpl, SimpleSourceTable, SourceTable, TimeTable, TreeTableImpl, UncoalescedTable, UpdatableTable, UpdateSourceQueryTable
public interface GridAttributes<TYPE extends GridAttributes<TYPE>> extends AttributeMap<TYPE>
Attribute-driven functionality shared by Table and other grid-like components.

  • Field Details

  • Method Details

    • restrictSortTo

      @ConcurrentMethod TYPE restrictSortTo(@NotNull @NotNull String... allowedSortingColumns)
      Disallow sorting on all but the specified columns.
      Parameters:
      allowedSortingColumns - The columns for which sorting is to be allowed
      Returns:
      A copy of this grid with the sort restrictions applied, or this if no change was needed

    • clearSortingRestrictions

      @ConcurrentMethod TYPE clearSortingRestrictions()
      Clear all sorting restrictions that were applied to the grid.
      Returns:
      A copy of this grid with the sort restrictions removed, or this if no change was needed

    • withDescription

      @ConcurrentMethod TYPE withDescription(@NotNull @NotNull String description)
      Apply a description to this grid.
      Parameters:
      description - The description to apply
      Returns:
      A copy of this grid with the description applied, or this if no change was needed

    • withColumnDescription

      @ConcurrentMethod TYPE withColumnDescription(@NotNull @NotNull String column, @NotNull @NotNull String description)
      Add a description for a specific column. Users should use withColumnDescriptions(Map) to set several descriptions at once.
      Parameters:
      column - The name of the column
      description - The column description
      Returns:
      A copy of this grid with the description applied, or this if no change was needed

    • withColumnDescriptions

      @ConcurrentMethod TYPE withColumnDescriptions(@NotNull @NotNull Map<String,String> descriptions)
      Add a set of column descriptions to the grid.
      Parameters:
      descriptions - A map of column name to column description
      Returns:
      A copy of this grid with the descriptions applied, or this if no change was needed

    • setLayoutHints

      @ConcurrentMethod TYPE setLayoutHints(@NotNull @NotNull String hints)
      Set layout hints for this grid.
      Parameters:
      hints - A packed string of layout hints
      Returns:
      A copy of this grid with the layout hints applied, or this if no change was needed

    • getColumnDescriptions

      @NotNull static @NotNull Map<String,String> getColumnDescriptions(@NotNull @NotNull Map<String,Object> attributes)
      Parameters:
      attributes - The map of attributes to examine
      Returns:
      A possibly-empty map from column name to description