Package io.deephaven.proto.pivot

Class PivotTableDescriptorMessage.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PivotTableDescriptorMessage.Builder>
io.deephaven.proto.pivot.PivotTableDescriptorMessage.Builder
All Implemented Interfaces:
Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, PivotTableDescriptorMessageOrBuilder, Cloneable
Enclosing class:
PivotTableDescriptorMessage
public static final class PivotTableDescriptorMessage.Builder extends GeneratedMessage.Builder<PivotTableDescriptorMessage.Builder> implements PivotTableDescriptorMessageOrBuilder
Protobuf type io.deephaven.proto.pivot.PivotTableDescriptorMessage

  • Method Details

    • getDescriptor

      public static final Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class GeneratedMessage.Builder<PivotTableDescriptorMessage.Builder>

    • clear

      public PivotTableDescriptorMessage.Builder clear()
      Specified by:
      clear in interface Message.Builder
      Specified by:
      clear in interface MessageLite.Builder
      Overrides:
      clear in class GeneratedMessage.Builder<PivotTableDescriptorMessage.Builder>

    • getDescriptorForType

      public Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface Message.Builder
      Specified by:
      getDescriptorForType in interface MessageOrBuilder
      Overrides:
      getDescriptorForType in class GeneratedMessage.Builder<PivotTableDescriptorMessage.Builder>

    • getDefaultInstanceForType

      public PivotTableDescriptorMessage getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface MessageOrBuilder

    • build

      public PivotTableDescriptorMessage build()
      Specified by:
      build in interface Message.Builder
      Specified by:
      build in interface MessageLite.Builder

    • buildPartial

      public PivotTableDescriptorMessage buildPartial()
      Specified by:
      buildPartial in interface Message.Builder
      Specified by:
      buildPartial in interface MessageLite.Builder

    • mergeFrom

      public PivotTableDescriptorMessage.Builder mergeFrom(Message other)
      Specified by:
      mergeFrom in interface Message.Builder
      Overrides:
      mergeFrom in class AbstractMessage.Builder<PivotTableDescriptorMessage.Builder>

    • mergeFrom

      public PivotTableDescriptorMessage.Builder mergeFrom(PivotTableDescriptorMessage other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface MessageLiteOrBuilder
      Overrides:
      isInitialized in class GeneratedMessage.Builder<PivotTableDescriptorMessage.Builder>

    • mergeFrom

      public PivotTableDescriptorMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface Message.Builder
      Specified by:
      mergeFrom in interface MessageLite.Builder
      Overrides:
      mergeFrom in class AbstractMessage.Builder<PivotTableDescriptorMessage.Builder>
      Throws:
      IOException

    • getSnapshotSchema

      public ByteString getSnapshotSchema()
       Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

 "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
 but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
 displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
 a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
 have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
 was used as input to this column. May have an empty value, because some aggregations take no input columns, for
 example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
 "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
      bytes snapshot_schema = 1;
      Specified by:
      getSnapshotSchema in interface PivotTableDescriptorMessageOrBuilder
      Returns:
      The snapshotSchema.

    • setSnapshotSchema

      public PivotTableDescriptorMessage.Builder setSnapshotSchema(ByteString value)
       Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

 "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
 but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
 displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
 a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
 have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
 was used as input to this column. May have an empty value, because some aggregations take no input columns, for
 example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
 "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
      bytes snapshot_schema = 1;
      Parameters:
      value - The snapshotSchema to set.
      Returns:
      This builder for chaining.

    • clearSnapshotSchema

      public PivotTableDescriptorMessage.Builder clearSnapshotSchema()
       Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

 "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
 but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
 displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
 a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
 have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
 was used as input to this column. May have an empty value, because some aggregations take no input columns, for
 example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
 "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
      bytes snapshot_schema = 1;
      Returns:
      This builder for chaining.

    • getIsStatic

      public boolean getIsStatic()
       Whether or not this table might change.
      bool is_static = 2;
      Specified by:
      getIsStatic in interface PivotTableDescriptorMessageOrBuilder
      Returns:
      The isStatic.

    • setIsStatic

      public PivotTableDescriptorMessage.Builder setIsStatic(boolean value)
       Whether or not this table might change.
      bool is_static = 2;
      Parameters:
      value - The isStatic to set.
      Returns:
      This builder for chaining.

    • clearIsStatic

      public PivotTableDescriptorMessage.Builder clearIsStatic()
       Whether or not this table might change.
      bool is_static = 2;
      Returns:
      This builder for chaining.