Package io.deephaven.api.agg.spec

Class AggSpecWSum

java.lang.Object

io.deephaven.api.agg.spec.AggSpecBase

io.deephaven.api.agg.spec.AggSpecWSum

All Implemented Interfaces:

AggSpec

@Immutable
public abstract class AggSpecWSum
extends AggSpecBase

Specifies an aggregation that outputs the sum of the input column values weighted by the weight column values for each group. Only works for numeric input types.

See Also:

• TableOperations.wsumBy(java.lang.String)

Nested Class Summary

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

AggSpec.Visitor

Constructor Summary

Constructors

Constructor	Description
AggSpecWSum()

Method Summary

Modifier and Type	Method	Description
final String	description()	Get a simple description for this AggSpec.
static AggSpecWSum	of(ColumnName weight)
final <V extends AggSpec.Visitor> V	walk(V visitor)	Glue method to deliver this AggSpec to a AggSpec.Visitor.
abstract ColumnName	weight()	Column name for the source of input weights.

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

Constructor Details

AggSpecWSum

public AggSpecWSum()

Method Details

of

public static AggSpecWSum of(ColumnName weight)

description

public final String description()

Description copied from interface: AggSpec

Get a simple description for this AggSpec.

Returns:

The description

weight

@Parameter
public abstract ColumnName weight()

Column name for the source of input weights.

Returns:

The weight column name

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