SqlToRelConverter.AggConverter (Calcite Core 1.16.0 API)

java.lang.Object
- org.apache.calcite.sql2rel.SqlToRelConverter.AggConverter

All Implemented Interfaces:

SqlVisitor<Void>

Enclosing class:

SqlToRelConverter
```
protected class SqlToRelConverter.AggConverter
extends Object
implements SqlVisitor<Void>
```
Converts expressions to aggregates.
Consider the expression
SELECT deptno, SUM(2 * sal) FROM emp GROUP BY deptno

Then:
- groupExprs = {SqlIdentifier(deptno)}
- convertedInputExprs = {RexInputRef(deptno), 2 * RefInputRef(sal)}
- inputRefs = {RefInputRef(#0), RexInputRef(#1)}
- aggCalls = {AggCall(SUM, {1})}

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<AggregateCall,RexNode>`	`aggCallMapping`
`private List<AggregateCall>`	`aggCalls`
`private Map<SqlNode,RexNode>`	`aggMapping`
`AggregatingSelectScope`	`aggregatingSelectScope`
`private Map<SqlNode,Ord<AuxiliaryConverter>>`	`auxiliaryGroupExprs` The auxiliary group-by expressions.
`private SqlToRelConverter.Blackboard`	`bb`
`private List<Pair<RexNode,String>>`	`convertedInputExprs` Input expressions for the group columns and aggregates, in `RexNode` format.
`private SqlNodeList`	`groupExprs` The group-by expressions, in `SqlNode` format.
`private boolean`	`inOver` Are we directly inside a windowed aggregate?
`private List<RexNode>`	`midExprs` Expressions to be evaluated as rows are being placed into the aggregate's hash table.
`private Map<String,String>`	`nameMap`

Constructor Summary

Constructors
Constructor and Description

AggConverter(SqlToRelConverter.Blackboard bb, SqlSelect select)
Creates an AggConverter.

Constructors
Constructor and Description
`AggConverter(SqlToRelConverter.Blackboard bb, SqlSelect select)` Creates an AggConverter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`addAuxiliaryGroupExpr(SqlNode node, int index, AuxiliaryConverter converter)`
`private void`	`addExpr(RexNode expr, String name)` Adds an expression, deducing an appropriate name if possible.
`int`	`addGroupExpr(SqlNode expr)`
`List<AggregateCall>`	`getAggCalls()`
`List<Pair<RexNode,String>>`	`getPreExprs()`
`RelDataTypeFactory`	`getTypeFactory()`
`RexNode`	`lookupAggregates(SqlCall call)`
`int`	`lookupGroupExpr(SqlNode expr)` If an expression is structurally identical to one of the group-by expressions, returns a reference to the expression, otherwise returns null.
`private int`	`lookupOrCreateGroupExpr(RexNode expr)`
`private void`	`translateAgg(SqlCall call, SqlNode filter, SqlCall outerCall)`
`Void`	`visit(SqlCall call)` Visits a call to a `SqlOperator`.
`Void`	`visit(SqlDataTypeSpec type)` Visits a datatype specification.
`Void`	`visit(SqlDynamicParam param)` Visits a dynamic parameter.
`Void`	`visit(SqlIdentifier id)` Visits an identifier.
`Void`	`visit(SqlIntervalQualifier intervalQualifier)` Visits an interval qualifier
`Void`	`visit(SqlLiteral lit)` Visits a literal.
`Void`	`visit(SqlNodeList nodeList)` Visits a list of `SqlNode` objects.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - bb
```
private final SqlToRelConverter.Blackboard bb
```
  - aggregatingSelectScope
```
public final AggregatingSelectScope aggregatingSelectScope
```
  - nameMap
```
private final Map<String,String> nameMap
```
  - groupExprs
```
private final SqlNodeList groupExprs
```
    The group-by expressions, in SqlNode format.
  - auxiliaryGroupExprs
```
private final Map<SqlNode,Ord<AuxiliaryConverter>> auxiliaryGroupExprs
```
    The auxiliary group-by expressions.
  - convertedInputExprs
```
private final List<Pair<RexNode,String>> convertedInputExprs
```
    Input expressions for the group columns and aggregates, in RexNode format. The first elements of the list correspond to the elements in groupExprs; the remaining elements are for aggregates. The right field of each pair is the name of the expression, where the expressions are simple mappings to input fields.
  - midExprs
```
private final List<RexNode> midExprs
```
    Expressions to be evaluated as rows are being placed into the aggregate's hash table. This is when group functions such as TUMBLE cause rows to be expanded.
  - aggCalls
```
private final List<AggregateCall> aggCalls
```
  - aggMapping
```
private final Map<SqlNode,RexNode> aggMapping
```
  - aggCallMapping
```
private final Map<AggregateCall,RexNode> aggCallMapping
```
  - inOver
```
private boolean inOver
```
    Are we directly inside a windowed aggregate?
- Constructor Detail
  - AggConverter
```
public AggConverter(SqlToRelConverter.Blackboard bb,
                    SqlSelect select)
```
    Creates an AggConverter.
    The select parameter provides enough context to name aggregate calls which are top-level select list items.
    
    Parameters:
    
    bb - Blackboard
    
    select - Query being translated; provides context to give
- Method Detail
  - addGroupExpr
```
public int addGroupExpr(SqlNode expr)
```
  - addAuxiliaryGroupExpr
```
void addAuxiliaryGroupExpr(SqlNode node,
                           int index,
                           AuxiliaryConverter converter)
```
  - addExpr
```
private void addExpr(RexNode expr,
                     String name)
```
    Adds an expression, deducing an appropriate name if possible.
    
    Parameters:
    
    expr - Expression
    
    name - Suggested name
  - visit
```
public Void visit(SqlIdentifier id)
```
    Description copied from interface: SqlVisitor
    
    Visits an identifier.
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    id - identifier
    
    See Also:
    
    SqlIdentifier.accept(SqlVisitor)
  - visit
```
public Void visit(SqlNodeList nodeList)
```
    Description copied from interface: SqlVisitor
    
    Visits a list of SqlNode objects.
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    nodeList - list of nodes
    
    See Also:
    
    SqlNodeList.accept(SqlVisitor)
  - visit
```
public Void visit(SqlLiteral lit)
```
    Description copied from interface: SqlVisitor
    
    Visits a literal.
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    lit - Literal
    
    See Also:
    
    SqlLiteral.accept(SqlVisitor)
  - visit
```
public Void visit(SqlDataTypeSpec type)
```
    Description copied from interface: SqlVisitor
    
    Visits a datatype specification.
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    type - datatype specification
    
    See Also:
    
    SqlDataTypeSpec.accept(SqlVisitor)
  - visit
```
public Void visit(SqlDynamicParam param)
```
    Description copied from interface: SqlVisitor
    
    Visits a dynamic parameter.
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    param - Dynamic parameter
    
    See Also:
    
    SqlDynamicParam.accept(SqlVisitor)
  - visit
```
public Void visit(SqlIntervalQualifier intervalQualifier)
```
    Description copied from interface: SqlVisitor
    
    Visits an interval qualifier
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    intervalQualifier - Interval qualifier
    
    See Also:
    
    SqlIntervalQualifier.accept(SqlVisitor)
  - visit
```
public Void visit(SqlCall call)
```
    Description copied from interface: SqlVisitor
    
    Visits a call to a SqlOperator.
    
    Specified by:
    
    visit in interface SqlVisitor<Void>
    
    Parameters:
    
    call - Call
    
    See Also:
    
    SqlCall.accept(SqlVisitor)
  - translateAgg
```
private void translateAgg(SqlCall call,
                          SqlNode filter,
                          SqlCall outerCall)
```
  - lookupOrCreateGroupExpr
```
private int lookupOrCreateGroupExpr(RexNode expr)
```
  - lookupGroupExpr
```
public int lookupGroupExpr(SqlNode expr)
```
    If an expression is structurally identical to one of the group-by expressions, returns a reference to the expression, otherwise returns null.
  - lookupAggregates
```
public RexNode lookupAggregates(SqlCall call)
```
  - getPreExprs
```
public List<Pair<RexNode,String>> getPreExprs()
```
  - getAggCalls
```
public List<AggregateCall> getAggCalls()
```
  - getTypeFactory
```
public RelDataTypeFactory getTypeFactory()
```

Class SqlToRelConverter.AggConverter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bb

aggregatingSelectScope

nameMap

groupExprs

auxiliaryGroupExprs

convertedInputExprs

midExprs

aggCalls

aggMapping

aggCallMapping

inOver

Constructor Detail

AggConverter

Method Detail

addGroupExpr

addAuxiliaryGroupExpr

addExpr

visit

visit

visit

visit

visit

visit

visit

translateAgg

lookupOrCreateGroupExpr

lookupGroupExpr

lookupAggregates

getPreExprs

getAggCalls

getTypeFactory