Package org.apache.calcite.sql.fun

Class SqlAbstractGroupFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.SqlAggFunction

org.apache.calcite.sql.fun.SqlAbstractGroupFunction

All Implemented Interfaces:

Context, Wrapper

public class SqlAbstractGroupFunction
extends SqlAggFunction

Base class for grouping functions GROUP_ID, GROUPING_ID, GROUPING.

Field Summary

Fields inherited from class org.apache.calcite.sql.SqlOperator

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlAbstractGroupFunction(String name, SqlKind kind, SqlReturnTypeInference returnTypeInference, @Nullable SqlOperandTypeInference operandTypeInference, SqlOperandTypeChecker operandTypeChecker, SqlFunctionCategory category)	Creates a SqlAbstractGroupFunction.

Method Summary

Modifier and Type	Method	Description
boolean	allowsFilter()	Whether this aggregate function allows a FILTER (WHERE ...) clause.
boolean	isQuantifierAllowed()	Returns whether this function allows a DISTINCT or ALL quantifier.
void	validateCall(SqlCall call, SqlValidator validator, SqlValidatorScope scope, SqlValidatorScope operandScope)	Validates a call to this operator.

Methods inherited from class org.apache.calcite.sql.SqlAggFunction

allowsNullTreatment, getDistinctOptionality, getParameterTypes, getReturnType, getRollup, isAggregator, isPercentile, requiresGroupOrder, requiresOrder, requiresOver, unwrap

Methods inherited from class org.apache.calcite.sql.SqlFunction

deriveType, getFunctionType, getNameAsId, getParamNames, getParamTypes, getSqlIdentifier, getSyntax, unparse, validateQuantifier

Methods inherited from class org.apache.calcite.sql.SqlOperator

acceptCall, acceptCall, adjustType, allowsFraming, argumentMustBeScalar, checkOperandCount, checkOperandTypes, constructArgNameList, constructArgTypeList, constructOperandList, createCall, createCall, createCall, createCall, createCall, createCall, createCall, deriveOperandType, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, getSqlCallFactory, getStrongPolicyInference, hashCode, inferReturnType, inferReturnType, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, not, preValidateCall, requiresDecimalExpansion, reverse, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.schema.Wrapper

maybeUnwrap, unwrapOrThrow

Constructor Details

SqlAbstractGroupFunction

public SqlAbstractGroupFunction(String name,
 SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 @Nullable SqlOperandTypeInference operandTypeInference,
 SqlOperandTypeChecker operandTypeChecker,
 SqlFunctionCategory category)

Creates a SqlAbstractGroupFunction.

Parameters:

name - Name of builtin function

kind - kind of operator implemented by function

returnTypeInference - strategy to use for return type inference

operandTypeInference - strategy to use for parameter type inference

operandTypeChecker - strategy to use for parameter type checking

category - categorization for function

Method Details

validateCall

public void validateCall(SqlCall call,
 SqlValidator validator,
 SqlValidatorScope scope,
 SqlValidatorScope operandScope)

Description copied from class: SqlOperator

Validates a call to this operator.

This method should not perform type-derivation or perform validation related related to types. That is done later, by SqlOperator.deriveType(SqlValidator, SqlValidatorScope, SqlCall). This method should focus on structural validation.

A typical implementation of this method first validates the operands, then performs some operator-specific logic. The default implementation just validates the operands.

This method is the default implementation of SqlCall.validate(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope); but note that some sub-classes of SqlCall never call this method.

Overrides:

validateCall in class SqlAggFunction

Parameters:

call - the call to this operator

validator - the active validator

scope - validator scope

operandScope - validator scope in which to validate operands to this call; usually equal to scope, but not always because some operators introduce new scopes

See Also:

• SqlNode.validateExpr(SqlValidator, SqlValidatorScope)
• SqlOperator.deriveType(SqlValidator, SqlValidatorScope, SqlCall)

isQuantifierAllowed

public boolean isQuantifierAllowed()

Description copied from class: SqlFunction

Returns whether this function allows a DISTINCT or ALL quantifier. The default is false; some aggregate functions return true.

Overrides:

isQuantifierAllowed in class SqlAggFunction

allowsFilter

public boolean allowsFilter()

Description copied from class: SqlAggFunction

Whether this aggregate function allows a FILTER (WHERE ...) clause.

Overrides:

allowsFilter in class SqlAggFunction