Package io.deephaven.proto.pivot

Interface PivotTableViewExpansionsMessageOrBuilder

All Superinterfaces:
MessageLiteOrBuilder, MessageOrBuilder
All Known Implementing Classes:
PivotTableViewExpansionsMessage, PivotTableViewExpansionsMessage.Builder
public interface PivotTableViewExpansionsMessageOrBuilder extends MessageOrBuilder

  • Method Details

    • hasRowKeyTableOffset

      boolean hasRowKeyTableOffset()
       Offset (in the references) of a Table of expanded or contracted keys from a PivotTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding PivotTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      optional int32 row_key_table_offset = 1;
      Returns:
      Whether the rowKeyTableOffset field is set.

    • getRowKeyTableOffset

      int getRowKeyTableOffset()
       Offset (in the references) of a Table of expanded or contracted keys from a PivotTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding PivotTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      optional int32 row_key_table_offset = 1;
      Returns:
      The rowKeyTableOffset.

    • hasRowKeyTableActionColumn

      boolean hasRowKeyTableActionColumn()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string row_key_table_action_column = 2;
      Returns:
      Whether the rowKeyTableActionColumn field is set.

    • getRowKeyTableActionColumn

      String getRowKeyTableActionColumn()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string row_key_table_action_column = 2;
      Returns:
      The rowKeyTableActionColumn.

    • getRowKeyTableActionColumnBytes

      ByteString getRowKeyTableActionColumnBytes()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string row_key_table_action_column = 2;
      Returns:
      The bytes for rowKeyTableActionColumn.

    • hasColumnKeyTableOffset

      boolean hasColumnKeyTableOffset()
       Offset (in the references) of a Table of expanded or contracted keys from a PivotTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding PivotTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      optional int32 column_key_table_offset = 3;
      Returns:
      Whether the columnKeyTableOffset field is set.

    • getColumnKeyTableOffset

      int getColumnKeyTableOffset()
       Offset (in the references) of a Table of expanded or contracted keys from a PivotTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding PivotTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      optional int32 column_key_table_offset = 3;
      Returns:
      The columnKeyTableOffset.

    • hasColumnKeyTableActionColumn

      boolean hasColumnKeyTableActionColumn()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string column_key_table_action_column = 4;
      Returns:
      Whether the columnKeyTableActionColumn field is set.

    • getColumnKeyTableActionColumn

      String getColumnKeyTableActionColumn()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string column_key_table_action_column = 4;
      Returns:
      The columnKeyTableActionColumn.

    • getColumnKeyTableActionColumnBytes

      ByteString getColumnKeyTableActionColumnBytes()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string column_key_table_action_column = 4;
      Returns:
      The bytes for columnKeyTableActionColumn.

    • getOutputColumnsList

      List<String> getOutputColumnsList()
       The name of the output columns that are sent, if not specified then all totals and value columns are sent.
      repeated string output_columns = 5;
      Returns:
      A list containing the outputColumns.

    • getOutputColumnsCount

      int getOutputColumnsCount()
       The name of the output columns that are sent, if not specified then all totals and value columns are sent.
      repeated string output_columns = 5;
      Returns:
      The count of outputColumns.

    • getOutputColumns

      String getOutputColumns(int index)
       The name of the output columns that are sent, if not specified then all totals and value columns are sent.
      repeated string output_columns = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The outputColumns at the given index.

    • getOutputColumnsBytes

      ByteString getOutputColumnsBytes(int index)
       The name of the output columns that are sent, if not specified then all totals and value columns are sent.
      repeated string output_columns = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the outputColumns at the given index.