Package io.deephaven.api.agg.spec

Interface AggSpec

All Known Implementing Classes:

AggSpecAbsSum, AggSpecApproximatePercentile, AggSpecAvg, AggSpecBase, AggSpecCountDistinct, AggSpecDistinct, AggSpecEmptyBase, AggSpecFirst, AggSpecFormula, AggSpecFreeze, AggSpecGroup, AggSpecLast, AggSpecMax, AggSpecMedian, AggSpecMin, AggSpecPercentile, AggSpecSortedFirst, AggSpecSortedLast, AggSpecStd, AggSpecSum, AggSpecTDigest, AggSpecUnique, AggSpecVar, AggSpecWAvg, AggSpecWSum

public interface AggSpec

An aggregation specification represents the configurable options for singular and compound column aggregations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AggSpec.Visitor

Method Summary

Modifier and Type	Method	Description
static AggSpecAbsSum	absSum()
ColumnAggregation	aggregation(Pair pair)	Build a ColumnAggregation for this AggSpec.
Aggregation	aggregation(Pair... pairs)	Build a singular or compound aggregation for this AggSpec.
Aggregation	aggregation(Collection<? extends Pair> pairs)	Build a singular or compound aggregation for this AggSpec.
static AggSpecApproximatePercentile	approximatePercentile(double percentile)
static AggSpecApproximatePercentile	approximatePercentile(double percentile, double compression)
static AggSpecAvg	avg()
static AggSpecCountDistinct	countDistinct()
static AggSpecCountDistinct	countDistinct(boolean countNulls)
String	description()	Get a simple description for this AggSpec.
static AggSpecDistinct	distinct()
static AggSpecDistinct	distinct(boolean includeNulls)
static AggSpecFirst	first()
static AggSpecFormula	formula(String formula)
static AggSpecFormula	formula(String formula, String paramToken)
static AggSpecFreeze	freeze()
static AggSpecGroup	group()
static AggSpecLast	last()
static AggSpecMax	max()
static AggSpecMedian	median()
static AggSpecMedian	median(boolean averageEvenlyDivided)
static AggSpecMin	min()
static AggSpecPercentile	percentile(double percentile)
static AggSpecPercentile	percentile(double percentile, boolean averageEvenlyDivided)
static AggSpecSortedFirst	sortedFirst(String... columns)
static AggSpecSortedFirst	sortedFirst(Collection<? extends String> columns)
static AggSpecSortedLast	sortedLast(String... columns)
static AggSpecSortedLast	sortedLast(Collection<? extends String> columns)
static AggSpecStd	std()
static AggSpecSum	sum()
static AggSpecTDigest	tDigest()
static AggSpecTDigest	tDigest(double compression)
static AggSpecUnique	unique()
static AggSpecUnique	unique(boolean includeNulls, UnionObject nonUniqueSentinel)
static AggSpecUnique	unique(boolean includeNulls, Object nonUniqueSentinel)
static AggSpecVar	var()
static void	visitAll(AggSpec.Visitor visitor)	Calls every single visit method of visitor with a null object.
<V extends AggSpec.Visitor> V	walk(V visitor)	Glue method to deliver this AggSpec to a AggSpec.Visitor.
static AggSpecWAvg	wavg(String weightColumn)
static AggSpecWSum	wsum(String weightColumn)

Method Details

absSum

static AggSpecAbsSum absSum()

Returns:

AggSpecAbsSum.of()

approximatePercentile

static AggSpecApproximatePercentile approximatePercentile(double percentile)

Returns:

AggSpecApproximatePercentile.of(double) for percentile

approximatePercentile

static AggSpecApproximatePercentile approximatePercentile(double percentile,
 double compression)

Returns:

AggSpecApproximatePercentile.of(double, double) for percentile and compression

avg

static AggSpecAvg avg()

Returns:

AggSpecAvg.of()

countDistinct

static AggSpecCountDistinct countDistinct()

countDistinct

static AggSpecCountDistinct countDistinct(boolean countNulls)

Returns:

AggSpecCountDistinct.of(boolean) for countNulls

distinct

static AggSpecDistinct distinct()

Returns:

AggSpecDistinct.of()

distinct

static AggSpecDistinct distinct(boolean includeNulls)

Returns:

AggSpecDistinct.of(boolean) for includeNulls

first

static AggSpecFirst first()

Returns:

AggSpecFirst.of()

formula

static AggSpecFormula formula(String formula)

Returns:

AggSpecFormula.of(String) for formula

formula

static AggSpecFormula formula(String formula,
 String paramToken)

Returns:

AggSpecFormula.of(String, String) for formula and paramToken

freeze

static AggSpecFreeze freeze()

Returns:

AggSpecFreeze.of()

group

static AggSpecGroup group()

Returns:

AggSpecGroup.of()

last

static AggSpecLast last()

Returns:

AggSpecLast.of()

max

static AggSpecMax max()

Returns:

AggSpecMax.of()

median

static AggSpecMedian median()

Returns:

AggSpecMedian.of()

median

static AggSpecMedian median(boolean averageEvenlyDivided)

Returns:

AggSpecMedian.of(boolean) for averageEvenlyDivided

min

static AggSpecMin min()

Returns:

AggSpecMin.of()

percentile

static AggSpecPercentile percentile(double percentile)

Returns:

AggSpecPercentile.of(double) for percentile

percentile

static AggSpecPercentile percentile(double percentile,
 boolean averageEvenlyDivided)

Returns:

AggSpecPercentile.of(double, boolean) for percentile and averageEvenlyDivided

sortedFirst

static AggSpecSortedFirst sortedFirst(String... columns)

Returns:

AggSpecSortedFirst for the supplied sort columns

sortedFirst

static AggSpecSortedFirst sortedFirst(Collection<? extends String> columns)

Returns:

AggSpecSortedFirst for the supplied sort columns

sortedLast

static AggSpecSortedLast sortedLast(String... columns)

Returns:

AggSpecSortedLast for the supplied sort columns

sortedLast

static AggSpecSortedLast sortedLast(Collection<? extends String> columns)

Returns:

AggSpecSortedLast for the supplied sort columns

std

static AggSpecStd std()

Returns:

AggSpecStd.of()

sum

static AggSpecSum sum()

Returns:

AggSpecSum.of()

tDigest

static AggSpecTDigest tDigest()

Returns:

AggSpecTDigest.of()

tDigest

static AggSpecTDigest tDigest(double compression)

Returns:

AggSpecTDigest.of(double) for compression

unique

static AggSpecUnique unique()

Returns:

AggSpecUnique.of()

unique

static AggSpecUnique unique(boolean includeNulls,
 Object nonUniqueSentinel)

Returns:

AggSpecUnique.of(boolean, Object) for includeNulls and nonUniqueSentinel

unique

static AggSpecUnique unique(boolean includeNulls,
 UnionObject nonUniqueSentinel)

Returns:

AggSpecUnique.of(boolean, UnionObject) for includeNulls and nonUniqueSentinel

var

static AggSpecVar var()

Returns:

AggSpecVar.of()

wavg

static AggSpecWAvg wavg(String weightColumn)

Returns:

AggSpecWAvg.of(ColumnName) for the supplied weightColumn

wsum

static AggSpecWSum wsum(String weightColumn)

Returns:

AggSpecWSum.of(ColumnName) for the supplied weightColumn

visitAll

static void visitAll(AggSpec.Visitor visitor)

Calls every single visit method of visitor with a null object.

Parameters:

visitor - the visitor

aggregation

ColumnAggregation aggregation(Pair pair)

Build a ColumnAggregation for this AggSpec.

Parameters:

pair - The input/output column name pair

Returns:

The aggregation

aggregation

Aggregation aggregation(Pair... pairs)

Build a singular or compound aggregation for this AggSpec.

Parameters:

pairs - The input/output column name pairs

Returns:

The aggregation

aggregation

Aggregation aggregation(Collection<? extends Pair> pairs)

Build a singular or compound aggregation for this AggSpec.

Parameters:

pairs - The input/output column name pairs

Returns:

The aggregation

description

String description()

Get a simple description for this AggSpec.

Returns:

The description

walk

<V extends AggSpec.Visitor> V walk(V visitor)

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

Parameters:

visitor - The visitor

Returns:

The visitor