Package io.deephaven.pivot

Class PivotTableSchemaConstants

java.lang.Object
io.deephaven.pivot.PivotTableSchemaConstants
Direct Known Subclasses:
PivotTableSchemaUtil
public class PivotTableSchemaConstants extends Object
Constants for interpreting Arrow schemas from io.deephaven.pivot.PivotTable instances.

  • Field Details

    • PIVOT_TABLE_IS_STRUCTURAL_COLUMN

      public static final String PIVOT_TABLE_IS_STRUCTURAL_COLUMN
      "pivotTable.isStructuralColumn" is always "true" if set, and is set on columns that should be included on every snapshot or subscription request, but should not be directly user-visible.
      See Also:

    • PIVOT_TABLE_IS_ROW_EXPAND_BY_COLUMN

      public static final String PIVOT_TABLE_IS_ROW_EXPAND_BY_COLUMN
      "pivotTable.isRowExpandByColumn" is always "true" if set, and is set on all the columns that must be included in a PivotTableViewRequest's row key table, if a row key table is specified. These columns are generally user-visible and displayed before other columns, unless they also have "pivotTable.isStructuralColumn" set.
      See Also:

    • PIVOT_TABLE_IS_ROW_DEPTH_COLUMN

      public static final String PIVOT_TABLE_IS_ROW_DEPTH_COLUMN
      "pivotTable.isRowDepthColumn" is always "true" if set, and is set on a single column that specifies the depth of a row. That column will always have "pivotTable.isRowExpandByColumn" set.
      See Also:

    • PIVOT_TABLE_IS_ROW_EXPANDED_COLUMN

      public static final String PIVOT_TABLE_IS_ROW_EXPANDED_COLUMN
      "pivotTable.isRowExpandedColumn" is always "true" if set, and 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.
      See Also:

    • PIVOT_TABLE_IS_ROW_GROUP_BY_COLUMN

      public static final String PIVOT_TABLE_IS_ROW_GROUP_BY_COLUMN
      "pivotTable.isRowGroupByColumn" is always "true" if set, and is set on all columns of a pivot that are row by-columns Such columns will always have "pivotTable.isRowExpandByColumn" set.
      See Also:

    • PIVOT_TABLE_IS_COLUMN_EXPAND_BY_COLUMN

      public static final String PIVOT_TABLE_IS_COLUMN_EXPAND_BY_COLUMN
      "pivotTable.isExpandByColumn" is always "true" if set, and is set on all the columns that must be included in a PivotTableViewRequest's key table, if a key table is specified. These columns are generally user-visible and displayed before other columns, unless they also have "pivotTable.isStructuralColumn" set.
      See Also:

    • PIVOT_TABLE_IS_COLUMN_DEPTH_COLUMN

      public static final String PIVOT_TABLE_IS_COLUMN_DEPTH_COLUMN
      "pivotTable.isColumnDepthColumn" is always "true" if set, and is set on a single column that specifies the depth of a column. That column will always have "pivotTable.isColumnExpandByColumn" set.
      See Also:

    • PIVOT_TABLE_IS_COLUMN_EXPANDED_COLUMN

      public static final String PIVOT_TABLE_IS_COLUMN_EXPANDED_COLUMN
      "pivotTable.isColumnExpandedColumn" is always "true" if set, and is set on a single nullable column of booleans that specifies whether a column is expandable or expanded. Values will be null for columns that are not expandable, true for expanded columns, false for columns that are not expanded (but expandable). Leaf columns have no children to expand, and hence will always have a null value for this column.
      See Also:

    • PIVOT_TABLE_IS_COLUMN_GROUP_BY_COLUMN

      public static final String PIVOT_TABLE_IS_COLUMN_GROUP_BY_COLUMN
      "pivotTable.isColumnGroupByColumn" is always "true" if set, and is set on all columns of a pivot that are column by-columns Such columns will always have "pivotTable.isColumnExpandByColumn" set.
      See Also:

    • PIVOT_TABLE_IS_ROW_VALUE_COLUMN

      public static final String PIVOT_TABLE_IS_ROW_VALUE_COLUMN
      "pivotTable.isRowValueColumn" is always "true" if set, and is set on all columns that are totals for a given row.
      See Also:

    • PIVOT_TABLE_IS_COLUMN_VALUE_COLUMN

      public static final String PIVOT_TABLE_IS_COLUMN_VALUE_COLUMN
      "pivotTable.isColumnValueColumn" is always "true" if set, and is set on all columns that are totals for a given column.
      See Also:

    • PIVOT_TABLE_IS_GRAND_TOTAL_VALUE_COLUMN

      public static final String PIVOT_TABLE_IS_GRAND_TOTAL_VALUE_COLUMN
      "pivotTable.isGrandTotalValueColumn" is always "true" if set, and 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.
      See Also:

    • PIVOT_TABLE_IS_VALUE_COLUMN

      public static final String PIVOT_TABLE_IS_VALUE_COLUMN
      "pivotTable.isValueColumn" is always "true" if set, and is set on all columns that are part of the main field (grid) of values.
      See Also:

    • PIVOT_TABLE_ROW_COLUMN_ATTRIBUTES

      public static final List<String> PIVOT_TABLE_ROW_COLUMN_ATTRIBUTES

    • PIVOT_TABLE_COLUMN_COLUMNS_ATTRIBUTES

      public static final List<String> PIVOT_TABLE_COLUMN_COLUMNS_ATTRIBUTES

    • PIVOT_TABLE_VALUE_COLUMNS_ATTRIBUTES

      public static final List<String> PIVOT_TABLE_VALUE_COLUMNS_ATTRIBUTES

    • PIVOT_TABLE_GRAND_TOTAL_COLUMNS_ATTRIBUTES

      public static final List<String> PIVOT_TABLE_GRAND_TOTAL_COLUMNS_ATTRIBUTES

    • PIVOT_TABLE_AGGREGATION_INPUT_COLUMN_NAME

      public static final String PIVOT_TABLE_AGGREGATION_INPUT_COLUMN_NAME
      "pivotTable.aggregationInputColumnName" is set to the (string) 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.
      See Also:

    • TRUE_STRING

      public static final String TRUE_STRING
      Re-usable constant for the "true" value.

  • Constructor Details

    • PivotTableSchemaConstants

      public PivotTableSchemaConstants()