Package io.deephaven.engine.table.impl.by

Class AggregationProcessor

java.lang.Object

io.deephaven.engine.table.impl.by.AggregationProcessor

All Implemented Interfaces:

AggregationContextFactory

public class AggregationProcessor
extends Object
implements AggregationContextFactory

Conversion tool to generate an AggregationContextFactory for a collection of aggregations.

Field Summary

Fields

Modifier and Type	Field	Description
static final ColumnName	EXPOSED_GROUP_ROW_SETS
static final ColumnName	ROLLUP_FORMULA_DEPTH	The name of the column we inject into AggFormula to permit the user to vary the formula based on which level of the rollup is being evaluated.
static final ColumnName	ROLLUP_FORMULA_KEYS	The name of the column we inject into AggFormula to permit the user to vary the formula based on the names of the key columns, by adding them as a Vector<String>.

Method Summary

Modifier and Type	Method	Description
static AggregationContextFactory	forAggregation(@NotNull Collection<? extends Aggregation> aggregations)	Convert a collection of aggregations to an AggregationContextFactory.
static AggregationContextFactory	forExposeGroupRowSets()	Create a trivial AggregationContextFactory to group the input table and expose the group row sets as EXPOSED_GROUP_ROW_SETS.
static AggregationContextFactory	forRollupBase(@NotNull Collection<? extends Aggregation> aggregations, boolean includeConstituents, @NotNull ColumnName rollupColumn)	Convert a collection of aggregations to an AggregationContextFactory for use in computing the base level of a rollup.
static AggregationContextFactory	forRollupReaggregated(@NotNull Collection<? extends Aggregation> aggregations, @NotNull Collection<ColumnDefinition<?>> nullColumns, @NotNull ColumnName rollupColumn, @NotNull Table source)	Convert a collection of aggregations to an AggregationContextFactory for use in computing a reaggregated level of a rollup.
static AggregationContextFactory	forRollupReaggregatedLeaf(@NotNull Collection<? extends Aggregation> aggregations, @NotNull Collection<ColumnDefinition<?>> nullColumns, @NotNull ColumnName rollupColumn)	Convert a collection of aggregations to an AggregationContextFactory for use in computing a reaggregated table, but without the ability to descend to the lower level (the rollupColumn is null).
static AggregationContextFactory	forSelectDistinct()	Create a trivial AggregationContextFactory to implement select distinct.
static AggregationContextFactory	forTreeSourceRowLookup()	Create a trivial AggregationContextFactory to implement source-row lookup functionality for tree.
static AggregationRowLookup	getRowLookup(@NotNull Table aggregationResult)
AggregationContext	makeAggregationContext(@NotNull Table table, boolean requireStateChangeRecorder, @NotNull String... groupByColumnNames)	Make an AggregationContext for this aggregation.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

EXPOSED_GROUP_ROW_SETS

public static final ColumnName EXPOSED_GROUP_ROW_SETS

ROLLUP_FORMULA_DEPTH

public static final ColumnName ROLLUP_FORMULA_DEPTH

The name of the column we inject into AggFormula to permit the user to vary the formula based on which level of the rollup is being evaluated.

ROLLUP_FORMULA_KEYS

public static final ColumnName ROLLUP_FORMULA_KEYS

The name of the column we inject into AggFormula to permit the user to vary the formula based on the names of the key columns, by adding them as a Vector<String>. Use together with __FORMULA_DEPTH__.

Method Details

forAggregation

public static AggregationContextFactory forAggregation(@NotNull
 @NotNull Collection<? extends Aggregation> aggregations)

Convert a collection of aggregations to an AggregationContextFactory.

Parameters:

aggregations - The aggregations. Must not be further mutated by the caller. Will not be mutated by AggregationProcessor.

Returns:

The AggregationContextFactory

forRollupBase

public static AggregationContextFactory forRollupBase(@NotNull
 @NotNull Collection<? extends Aggregation> aggregations,
 boolean includeConstituents,
 @NotNull
 @NotNull ColumnName rollupColumn)

Convert a collection of aggregations to an AggregationContextFactory for use in computing the base level of a rollup.

Parameters:

aggregations - The aggregations. Must not be further mutated by the caller. Will not be mutated by AggregationProcessor.

includeConstituents - Whether constituents should be included via a partition aggregation

Returns:

The AggregationContextFactory

forRollupReaggregated

public static AggregationContextFactory forRollupReaggregated(@NotNull
 @NotNull Collection<? extends Aggregation> aggregations,
 @NotNull
 @NotNull Collection<ColumnDefinition<?>> nullColumns,
 @NotNull
 @NotNull ColumnName rollupColumn,
 @NotNull
 @NotNull Table source)

Convert a collection of aggregations to an AggregationContextFactory for use in computing a reaggregated level of a rollup.

Parameters:

aggregations - The aggregations. Must not be further mutated by the caller. Will not be mutated by AggregationProcessor.

nullColumns - Map of group-by column names and data types to aggregate with a null-column aggregation

rollupColumn - the name of the rollup column in the result, used to traverse to the next lower level nodes

source - the original source table of the rollup (not the table we are reaggregating)

Returns:

The AggregationContextFactory

forRollupReaggregatedLeaf

public static AggregationContextFactory forRollupReaggregatedLeaf(@NotNull
 @NotNull Collection<? extends Aggregation> aggregations,
 @NotNull
 @NotNull Collection<ColumnDefinition<?>> nullColumns,
 @NotNull
 @NotNull ColumnName rollupColumn)

Convert a collection of aggregations to an AggregationContextFactory for use in computing a reaggregated table, but without the ability to descend to the lower level (the rollupColumn is null).

Parameters:

aggregations - The aggregations. Must not be further mutated by the caller. Will not be mutated by AggregationProcessor.

nullColumns - Map of group-by column names and data types to aggregate with a null-column aggregation

rollupColumn - the name of the rollup column in the result, which is always a null result

Returns:

The AggregationContextFactory

forTreeSourceRowLookup

public static AggregationContextFactory forTreeSourceRowLookup()

Create a trivial AggregationContextFactory to implement source-row lookup functionality for tree.

Returns:

The AggregationContextFactory

forSelectDistinct

public static AggregationContextFactory forSelectDistinct()

Create a trivial AggregationContextFactory to implement select distinct.

Returns:

The AggregationContextFactory

forExposeGroupRowSets

public static AggregationContextFactory forExposeGroupRowSets()

Create a trivial AggregationContextFactory to group the input table and expose the group row sets as EXPOSED_GROUP_ROW_SETS.

Returns:

The AggregationContextFactory

toString

public String toString()

Overrides:

toString in class Object

makeAggregationContext

public AggregationContext makeAggregationContext(@NotNull
 @NotNull Table table,
 boolean requireStateChangeRecorder,
 @NotNull
 @NotNull String... groupByColumnNames)

Description copied from interface: AggregationContextFactory

Make an AggregationContext for this aggregation.

Specified by:

makeAggregationContext in interface AggregationContextFactory

Parameters:

table - The source Table to aggregate

requireStateChangeRecorder - Whether the resulting context is required to have an operator that extends StateChangeRecorder

groupByColumnNames - The key column names

Returns:

A new or safely reusable AggregationContext

getRowLookup

public static AggregationRowLookup getRowLookup(@NotNull
 @NotNull Table aggregationResult)