org.apache.calcite.rel.core

Class AggregateCall

java.lang.Object

org.apache.calcite.rel.core.AggregateCall

public class AggregateCall
extends Object

Call to an aggFunction function within an LogicalAggregate.

Field Summary

Fields

Modifier and Type	Field and Description
String	name
RelDataType	type

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
AggregateCall	adaptTo(RelNode input, List<Integer> aggArgs, int oldGroupKeyCount, int newGroupKeyCount) Creates equivalent AggregateCall that is adapted to a new input types and/or number of columns in GROUP BY.
AggregateCall	copy(List<Integer> args) Creates an equivalent AggregateCall with new argument ordinals.
static AggregateCall	create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int groupCount, RelNode input, RelDataType type, String name) Creates an AggregateCall, inferring its type if type is null.
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(Object o)
SqlAggFunction	getAggregation() Returns the aggregate function.
List<Integer>	getArgList() Returns the ordinals of the arguments to this call.
String	getName() Returns the name.
RelDataType	getType() Returns the result type.
int	hashCode()
boolean	isDistinct() Returns whether this AggregateCall is distinct, as in COUNT(DISTINCT empno).
AggregateCall	rename(String name) Creates an equivalent AggregateCall that has a new name.
String	toString()
AggregateCall	transform(Mappings.TargetMapping mapping) Creates a copy of this aggregate call, applying a mapping to its arguments.

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 String name

Constructor Detail

AggregateCall

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

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

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

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

isDistinct

public final boolean isDistinct()

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

Returns:

whether distinct

getAggregation

public final SqlAggFunction getAggregation()

Returns the aggregate function.

Returns:

aggregate function

getArgList

public final List<Integer> getArgList()

Returns the ordinals of the arguments to this call.

The list is immutable.

Returns:

list of argument ordinals

getType

public final RelDataType getType()

Returns the result type.

Returns:

result type

getName

public String getName()

Returns the name.

Returns:

name

rename

public AggregateCall rename(String name)

Creates an equivalent AggregateCall that has a new name.

Parameters:

name - New name (may be null)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(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

public AggregateCall copy(List<Integer> args)

Creates an equivalent AggregateCall with new argument ordinals.

Parameters:

args - Arguments

Returns:

AggregateCall that suits new inputs and GROUP BY columns

adaptTo

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

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

Parameters:

input - relation that will be used as a child of aggregate

aggArgs - argument indices of the new call in the input

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.