Package io.deephaven.api.agg.spec

Class AggSpecFormula

java.lang.Object

io.deephaven.api.agg.spec.AggSpecBase

io.deephaven.api.agg.spec.AggSpecFormula

All Implemented Interfaces:

AggSpec

@Immutable
public abstract class AggSpecFormula
extends AggSpecBase

Specifies an aggregation that applies a formula to each input group (as a Deephaven vector (io.deephaven.vector.Vector)) to produce the corresponding output value. Each input column name is substituted for the param token for evaluation.

Nested Class Summary

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

AggSpec.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_TOKEN_DEFAULT

Constructor Summary

Constructors

Constructor	Description
AggSpecFormula()

Method Summary

Modifier and Type	Method	Description
final String	description()	Get a simple description for this AggSpec.
abstract String	formula()	The formula to use to calculate output values from grouped input values.
static AggSpecFormula	of(String formula)	Creates a new AggSpecFormula with paramToken of "each".
static AggSpecFormula	of(String formula, String paramToken)	Creates a new AggSpecFormula.
abstract String	paramToken()	The formula parameter token to be replaced with the input column name for evaluation.
final <V extends AggSpec.Visitor> V	walk(V visitor)	Glue method to deliver this AggSpec to a AggSpec.Visitor.

Methods inherited from class io.deephaven.api.agg.spec.AggSpecBase

aggregation, aggregation, aggregation

Methods inherited from class java.lang.Object

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

Field Details

PARAM_TOKEN_DEFAULT

public static final String PARAM_TOKEN_DEFAULT

See Also:

• Constant Field Values

Constructor Details

AggSpecFormula

public AggSpecFormula()

Method Details

of

public static AggSpecFormula of(String formula)

Creates a new AggSpecFormula with paramToken of "each".

todo The

Parameters:

formula - the formula

Returns:

the AggSpecFormula

of

public static AggSpecFormula of(String formula,
 String paramToken)

Creates a new AggSpecFormula.

Parameters:

formula - the formula

paramToken - the param token

Returns:

the AggSpecFormula

description

public final String description()

Description copied from interface: AggSpec

Get a simple description for this AggSpec.

Returns:

The description

formula

@Parameter
public abstract String formula()

The formula to use to calculate output values from grouped input values.

Returns:

The formula

paramToken

@Parameter
public abstract String paramToken()

The formula parameter token to be replaced with the input column name for evaluation.

Returns:

The parameter token

walk

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

Description copied from interface: AggSpec

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

Parameters:

visitor - The visitor

Returns:

The visitor