AggregateCall (Calcite Core 1.16.0 API)

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
`private SqlAggFunction`	`aggFunction`
`private boolean`	`approximate`
`private com.google.common.collect.ImmutableList<Integer>`	`argList`
`private boolean`	`distinct`
`int`	`filterArg`
`String`	`name`
`RelDataType`	`type`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`AggregateCall(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, RelDataType type, String name)` Creates an AggregateCall.
	`AggregateCall(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, RelDataType type, String name)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AggregateCall`	`adaptTo(RelNode input, List<Integer> argList, int filterArg, 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)` Deprecated.
`AggregateCall`	`copy(List<Integer> args, int filterArg)` Creates an equivalent AggregateCall with new argument ordinals.
`static AggregateCall`	`create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, int groupCount, RelNode input, RelDataType type, String name)` Creates an AggregateCall, inferring its type if `type` is null.
`static AggregateCall`	`create(SqlAggFunction aggFunction, boolean distinct, boolean approximate, List<Integer> argList, int filterArg, RelDataType type, String name)` Creates an AggregateCall.
`static AggregateCall`	`create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int filterArg, int groupCount, RelNode input, RelDataType type, String name)` Deprecated.
`static AggregateCall`	`create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int filterArg, RelDataType type, String name)` Deprecated.
`static AggregateCall`	`create(SqlAggFunction aggFunction, boolean distinct, List<Integer> argList, int groupCount, RelNode input, RelDataType type, 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(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.
`boolean`	`hasFilter()` Returns true if and only if this AggregateCall has a filter argument
`int`	`hashCode()`
`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(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

aggFunction

private final SqlAggFunction aggFunction

distinct
```
private final boolean distinct
```

approximate
```
private final boolean approximate
```

type
```
public final RelDataType type
```

name
```
public final String name
```

argList

private final com.google.common.collect.ImmutableList<Integer> argList

filterArg
```
public final int filterArg
```

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)

AggregateCall

private AggregateCall(SqlAggFunction aggFunction,
                      boolean distinct,
                      boolean approximate,
                      List<Integer> argList,
                      int filterArg,
                      RelDataType type,
                      String name)

Creates an AggregateCall.

Parameters:: aggFunction - Aggregate function; distinct - Whether distinct; approximate - Whether approximate; argList - List of ordinals of arguments; filterArg - Ordinal of filter argument, or -1; 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,
                                               RelDataType type,
                                               String name)

Deprecated.

create

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

Deprecated.

create

public static AggregateCall create(SqlAggFunction aggFunction,
                                   boolean distinct,
                                   boolean approximate,
                                   List<Integer> argList,
                                   int filterArg,
                                   int groupCount,
                                   RelNode input,
                                   RelDataType type,
                                   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,
                                               String name)

Deprecated.

create

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

Creates an AggregateCall.

isDistinct
```
public final boolean isDistinct()
```
Returns whether this AggregateCall is distinct, as in COUNT(DISTINCT empno).

Returns:

whether distinct

isApproximate
```
public final boolean isApproximate()
```
Returns whether this AggregateCall is approximate, as in APPROX_COUNT_DISTINCT(empno).

Returns:

whether approximate

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

hasFilter
```
public boolean hasFilter()
```
Returns true if and only if this AggregateCall has a filter argument

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,
                          int filterArg)
```
Creates an equivalent AggregateCall with new argument ordinals.

Parameters:

args - Arguments

Returns:

AggregateCall that suits new inputs and GROUP BY columns

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

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.

Class AggregateCall

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

aggFunction

distinct

approximate

type

name

argList

filterArg

Constructor Detail

AggregateCall

AggregateCall

Method Detail

create

create

create

create

create

isDistinct

isApproximate

getAggregation

getArgList

getType

getName

rename

toString

hasFilter

equals

hashCode

createBinding

copy

copy

adaptTo

transform