Package io.deephaven.api.agg.spec

Class AggSpecDistinct

java.lang.Object

io.deephaven.api.agg.spec.AggSpecBase

io.deephaven.api.agg.spec.AggSpecDistinct

All Implemented Interfaces:

AggSpec

@Immutable
public abstract class AggSpecDistinct
extends AggSpecBase

Specifies an aggregation that outputs the distinct values for each group as a Deephaven vector (io.deephaven.vector.Vector).

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 boolean	INCLUDE_NULLS_DEFAULT

Constructor Summary

Constructors

Constructor	Description
AggSpecDistinct()

Method Summary

Modifier and Type	Method	Description
final String	description()	Get a simple description for this AggSpec.
abstract boolean	includeNulls()	Whether null input values should be included in the distinct output values.
static AggSpecDistinct	of()	Create a new AggSpecDistinct with includeNulls of false.
static AggSpecDistinct	of(boolean includeNulls)	Create a new AggSpecDistinct.
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

INCLUDE_NULLS_DEFAULT

public static final boolean INCLUDE_NULLS_DEFAULT

See Also:

• Constant Field Values

Constructor Details

AggSpecDistinct

public AggSpecDistinct()

Method Details

of

public static AggSpecDistinct of()

Create a new AggSpecDistinct with includeNulls of false.

Returns:

the agg spec

of

public static AggSpecDistinct of(boolean includeNulls)

Create a new AggSpecDistinct.

Parameters:

includeNulls - if nulls should be included as distinct values

Returns:

the agg spec

description

public final String description()

Description copied from interface: AggSpec

Get a simple description for this AggSpec.

Returns:

The description

includeNulls

@Parameter
public abstract boolean includeNulls()

Whether null input values should be included in the distinct output values.

Returns:

Whether to include nulls

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