Package io.deephaven.api.agg

Class Formula

java.lang.Object

io.deephaven.api.agg.Formula

All Implemented Interfaces:

Aggregation

@Immutable
public abstract class Formula
extends Object
implements Aggregation

An aggregation that provides a single output column that is computed by applying a formula to a set of input columns.

Nested Class Summary

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

Aggregation.Visitor

Constructor Summary

Constructors

Constructor	Description
Formula()

Method Summary

Modifier and Type	Method	Description
Formula	asReaggregating()	Return a copy of this formula that will be applied to the prior level of the rollup.
ColumnName	column()
Expression	expression()
String	formulaString()	Return this Formula as a string of the form <newColumn>=<expression>
static Formula	of(ColumnName name, String formula)
static Formula	of(Selectable selectable)
static Formula	of(String name, String formula)
static Formula	parse(String formulaString)
abstract boolean	reaggregateAggregatedValues()
abstract Selectable	selectable()
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

Formula

public Formula()

Method Details

parse

public static Formula parse(String formulaString)

of

public static Formula of(String name,
 String formula)

of

public static Formula of(ColumnName name,
 String formula)

of

public static Formula of(Selectable selectable)

asReaggregating

public Formula asReaggregating()

Return a copy of this formula that will be applied to the prior level of the rollup.

The reaggregating parameter has no effect when not part of a rollup.

Returns:

a copy of this formula that is applied to the prior level of the rollup

selectable

@Parameter
public abstract Selectable selectable()

reaggregateAggregatedValues

@Parameter
public abstract boolean reaggregateAggregatedValues()

column

public ColumnName column()

expression

public Expression expression()

formulaString

public String formulaString()

Return this Formula as a string of the form <newColumn>=<expression>

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