org.apache.calcite.rel.core

Class AggregateCall

java.lang.Object

org.apache.calcite.rel.core.AggregateCall

public class AggregateCall
extends Object

Call to an aggregate function within an Aggregate.

Field Summary

Fields

Modifier and Type	Field and Description
RelCollation	collation
@Nullable ImmutableBitSet	distinctKeys
int	filterArg
@Nullable String	name
RelDataType	type

Constructor Summary

Constructors

Constructor and Description
AggregateCall(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, RelDataType type, String name) Deprecated.

Method Summary

Modifier and Type	Method and Description
AggregateCall	adaptTo(RelNode input, List<Integer> argList, int filterArg, int oldGroupKeyCount, int newGroupKeyCount) Creates an equivalent AggregateCall that is adapted to a new input types and/or number of columns in GROUP BY.
AggregateCall	copy(List<Integer> args) Deprecated.
AggregateCall	copy(List<Integer> args, int filterArg) Deprecated.
AggregateCall	copy(List<Integer> args, int filterArg, @Nullable ImmutableBitSet distinctKeys, RelCollation collation) Deprecated.
AggregateCall	copy(List<Integer> args, int filterArg, RelCollation collation) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, boolean ignoreNulls, List<Integer> argList, int filterArg, @Nullable ImmutableBitSet distinctKeys, RelCollation collation, int groupCount, RelNode input, @Nullable RelDataType type, @Nullable String name) Creates an AggregateCall, inferring its type if type is null.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, boolean ignoreNulls, List<Integer> argList, int filterArg, @Nullable ImmutableBitSet distinctKeys, RelCollation collation, RelDataType type, @Nullable String name) Creates an AggregateCall.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, boolean ignoreNulls, List<Integer> argList, int filterArg, RelCollation collation, RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, int groupCount, RelNode input, @Nullable RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, RelCollation collation, int groupCount, RelNode input, @Nullable RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, RelCollation collation, RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int filterArg, int groupCount, RelNode input, @Nullable RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int filterArg, RelDataType type, @Nullable String name) Deprecated.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int groupCount, RelNode input, @Nullable RelDataType type, @Nullable String name) Deprecated.
Aggregate.AggCallBinding	createBinding(Aggregate aggregateRelBase) Creates a binding of this call in the context of an LogicalAggregate, which can then be used to infer the return type.
boolean	equals(@Nullable Object o)
SqlAggFunction	getAggregation() Returns the aggregate function.
List<Integer>	getArgList() Returns the ordinals of the arguments to this call.
RelCollation	getCollation() Returns the aggregate ordering definition (the WITHIN GROUP clause in SQL), or the empty list if not specified.
@Nullable String	getName() Returns the name.
RelDataType	getType() Returns the result type.
boolean	hasFilter() Returns whether this AggregateCall has a filter argument.
int	hashCode()
boolean	ignoreNulls() Returns whether this AggregateCall ignores nulls.
boolean	isApproximate() Returns whether this AggregateCall is approximate, as in APPROX_COUNT_DISTINCT(empno).
boolean	isDistinct() Returns whether this AggregateCall is distinct, as in COUNT(DISTINCT empno).
AggregateCall	rename(@Nullable String name) Deprecated.
String	toString()
AggregateCall	transform(Mappings.TargetMapping mapping) Creates a copy of this aggregate call, applying a mapping to its arguments.
AggregateCall	withApproximate(boolean approximate) Withs isApproximate().
AggregateCall	withArgList(List<Integer> argList) Withs getArgList().
AggregateCall	withCollation(RelCollation collation) Withs getCollation().
AggregateCall	withDistinct(boolean distinct) Withs isDistinct().
AggregateCall	withDistinctKeys(@Nullable ImmutableBitSet distinctKeys) Withs distinctKeys.
AggregateCall	withFilter(int filterArg) Withs filterArg.
AggregateCall	withIgnoreNulls(boolean ignoreNulls) Withs ignoreNulls().
AggregateCall	withName(@Nullable String name) Withs name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

public final RelDataType type

name

public final @Nullable String name

filterArg

public final int filterArg

distinctKeys

public final @Nullable ImmutableBitSet distinctKeys

collation

public final RelCollation collation

Constructor Detail

AggregateCall

@Deprecated
public AggregateCall(SqlAggFunction aggFunction,
                                 boolean distinct,
                                 List<Integer> argList,
                                 RelDataType type,
                                 String name)

Deprecated.

Creates an AggregateCall.

Parameters:

aggFunction - Aggregate function

distinct - Whether distinct

argList - List of ordinals of arguments

type - Result type

name - Name (may be null)

Method Detail

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               List<Integer> argList,
                                               int groupCount,
                                               RelNode input,
                                               @Nullable RelDataType type,
                                               @Nullable String name)

Deprecated.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               List<Integer> argList,
                                               int filterArg,
                                               int groupCount,
                                               RelNode input,
                                               @Nullable RelDataType type,
                                               @Nullable String name)

Deprecated.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               boolean approximate,
                                               List<Integer> argList,
                                               int filterArg,
                                               int groupCount,
                                               RelNode input,
                                               @Nullable RelDataType type,
                                               @Nullable String name)

Deprecated.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               boolean approximate,
                                               List<Integer> argList,
                                               int filterArg,
                                               RelCollation collation,
                                               int groupCount,
                                               RelNode input,
                                               @Nullable RelDataType type,
                                               @Nullable String name)

Deprecated.

create

public static AggregateCall create(SqlAggFunction aggFunction,
                                   boolean distinct,
                                   boolean approximate,
                                   boolean ignoreNulls,
                                   List<Integer> argList,
                                   int filterArg,
                                   @Nullable ImmutableBitSet distinctKeys,
                                   RelCollation collation,
                                   int groupCount,
                                   RelNode input,
                                   @Nullable RelDataType type,
                                   @Nullable String name)

Creates an AggregateCall, inferring its type if type is null.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               List<Integer> argList,
                                               int filterArg,
                                               RelDataType type,
                                               @Nullable String name)

Deprecated.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               boolean approximate,
                                               List<Integer> argList,
                                               int filterArg,
                                               RelDataType type,
                                               @Nullable String name)

Deprecated.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               boolean approximate,
                                               List<Integer> argList,
                                               int filterArg,
                                               RelCollation collation,
                                               RelDataType type,
                                               @Nullable String name)

Deprecated.

create

@Deprecated
public static AggregateCall create(SqlAggFunction aggFunction,
                                               boolean distinct,
                                               boolean approximate,
                                               boolean ignoreNulls,
                                               List<Integer> argList,
                                               int filterArg,
                                               RelCollation collation,
                                               RelDataType type,
                                               @Nullable String name)

Deprecated.

create

public static AggregateCall create(SqlAggFunction aggFunction,
                                   boolean distinct,
                                   boolean approximate,
                                   boolean ignoreNulls,
                                   List<Integer> argList,
                                   int filterArg,
                                   @Nullable ImmutableBitSet distinctKeys,
                                   RelCollation collation,
                                   RelDataType type,
                                   @Nullable String name)

Creates an AggregateCall.

isDistinct

public final boolean isDistinct()

Returns whether this AggregateCall is distinct, as in COUNT(DISTINCT empno).

Returns:

whether distinct

withDistinct

public AggregateCall withDistinct(boolean distinct)

Withs isDistinct().

isApproximate

public final boolean isApproximate()

Returns whether this AggregateCall is approximate, as in APPROX_COUNT_DISTINCT(empno).

Returns:

whether approximate

withApproximate

public AggregateCall withApproximate(boolean approximate)

Withs isApproximate().

ignoreNulls

public final boolean ignoreNulls()

Returns whether this AggregateCall ignores nulls.

Returns:

whether ignore nulls

withIgnoreNulls

public AggregateCall withIgnoreNulls(boolean ignoreNulls)

Withs ignoreNulls().

getAggregation

public final SqlAggFunction getAggregation()

Returns the aggregate function.

Returns:

aggregate function

getCollation

public RelCollation getCollation()

Returns the aggregate ordering definition (the WITHIN GROUP clause in SQL), or the empty list if not specified.

Returns:

ordering definition

withCollation

public AggregateCall withCollation(RelCollation collation)

Withs getCollation().

getArgList

public final List<Integer> getArgList()

Returns the ordinals of the arguments to this call.

The list is immutable.

Returns:

list of argument ordinals

withArgList

public AggregateCall withArgList(List<Integer> argList)

Withs getArgList().

withDistinctKeys

public AggregateCall withDistinctKeys(@Nullable ImmutableBitSet distinctKeys)

Withs distinctKeys.

getType

public final RelDataType getType()

Returns the result type.

Returns:

result type

getName

public @Nullable String getName()

Returns the name.

Returns:

name

withName

public AggregateCall withName(@Nullable String name)

Withs name.

rename

@Deprecated
public AggregateCall rename(@Nullable String name)

Deprecated.

toString

public String toString()

Overrides:

toString in class Object

hasFilter

public boolean hasFilter()

Returns whether this AggregateCall has a filter argument.

withFilter

public AggregateCall withFilter(int filterArg)

Withs filterArg.

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createBinding

public Aggregate.AggCallBinding createBinding(Aggregate aggregateRelBase)

Creates a binding of this call in the context of an LogicalAggregate, which can then be used to infer the return type.

copy

@Deprecated
public AggregateCall copy(List<Integer> args,
                                      int filterArg,
                                      @Nullable ImmutableBitSet distinctKeys,
                                      RelCollation collation)

Deprecated.

Creates an equivalent AggregateCall with new argument ordinals.

Parameters:

args - Arguments

Returns:

AggregateCall that suits new inputs and GROUP BY columns

See Also:

transform(Mappings.TargetMapping)

copy

@Deprecated
public AggregateCall copy(List<Integer> args,
                                      int filterArg,
                                      RelCollation collation)

Deprecated.

copy

@Deprecated
public AggregateCall copy(List<Integer> args,
                                      int filterArg)

Deprecated.

copy

@Deprecated
public AggregateCall copy(List<Integer> args)

Deprecated.

adaptTo

public AggregateCall adaptTo(RelNode input,
                             List<Integer> argList,
                             int filterArg,
                             int oldGroupKeyCount,
                             int newGroupKeyCount)

Creates an equivalent AggregateCall that is adapted to a new input types and/or number of columns in GROUP BY.

Parameters:

input - Relation that will be input of Aggregate

argList - Argument indices of the new call in the input

filterArg - Index of the filter, or -1

oldGroupKeyCount - number of columns in GROUP BY of old aggregate

newGroupKeyCount - number of columns in GROUP BY of new aggregate

Returns:

AggregateCall that suits new inputs and GROUP BY columns

transform

public AggregateCall transform(Mappings.TargetMapping mapping)

Creates a copy of this aggregate call, applying a mapping to its arguments.