Package io.deephaven.api.agg

Class Partition

java.lang.Object

io.deephaven.api.agg.Partition

All Implemented Interfaces:

Aggregation

@Immutable
public abstract class Partition
extends Object
implements Aggregation

An Aggregation that provides a single output column with sub-tables of the input table for each aggregation group in the result.

If the input table is refreshing, the sub-tables will be also. Note that the output column will never report modifications, only additions or removals; users should listen to the sub-tables individually or as a merged result in order to be notified of sub-table updates. This allows for fine-grained, parallelizable incremental updates, as distinct from the result of a grouping column aggregation.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.api.agg.Aggregation

Aggregation.Visitor

Constructor Summary

Constructors

Constructor	Description
Partition()

Method Summary

Modifier and Type	Method	Description
abstract ColumnName	column()
boolean	includeGroupByColumns()	Whether group-by columns (sometimes referred to as "key" columns) should be included in the output sub-tables.
static Partition	of(ColumnName name)
static Partition	of(ColumnName name, boolean includeGroupByColumns)
static Partition	of(String x)
static Partition	of(String x, boolean includeGroupByColumns)
final <V extends Aggregation.Visitor> V	walk(V visitor)	Glue method to deliver this Aggregation to a AggSpec.Visitor.

Methods inherited from class java.lang.Object

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

Constructor Details

Partition

public Partition()

Method Details

of

public static Partition of(ColumnName name)

of

public static Partition of(String x)

of

public static Partition of(ColumnName name,
 boolean includeGroupByColumns)

of

public static Partition of(String x,
 boolean includeGroupByColumns)

column

@Parameter
public abstract ColumnName column()

includeGroupByColumns

@Default
public boolean includeGroupByColumns()

Whether group-by columns (sometimes referred to as "key" columns) should be included in the output sub-tables.

Returns:

Whether to include group-by columns in the output sub-tables

walk

public final <V extends Aggregation.Visitor> V walk(V visitor)

Description copied from interface: Aggregation

Glue method to deliver this Aggregation to a AggSpec.Visitor.

Specified by:

walk in interface Aggregation

Parameters:

visitor - The visitor

Returns:

The visitor