org.apache.calcite.sql.fun

Class SqlBasicAggFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.SqlAggFunction

org.apache.calcite.sql.fun.SqlBasicAggFunction

All Implemented Interfaces:

Context, Wrapper

public final class SqlBasicAggFunction
extends SqlAggFunction

Concrete implementation of SqlAggFunction.

The class is final, and instances are immutable.

Instances are created only by create(org.apache.calcite.sql.SqlKind, org.apache.calcite.sql.type.SqlReturnTypeInference, org.apache.calcite.sql.type.SqlOperandTypeChecker) and are "modified" by "wither" methods such as withDistinct(org.apache.calcite.util.Optionality) to create a new instance with one property changed. Since the class is final, you can modify behavior only by providing strategy objects, not by overriding methods in a sub-class.

Field Summary

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

kind, MDX_PRECEDENCE, NL

Method Summary

Modifier and Type	Method and Description
boolean	allowsNullTreatment() Returns whether this aggregate function allows specifying null treatment (RESPECT NULLS or IGNORE NULLS).
boolean	allowsSeparator() Returns whether this aggregate function allows 'SEPARATOR string' among its arguments.
static SqlBasicAggFunction	create(SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeChecker operandTypeChecker) Creates a SqlBasicAggFunction whose name is the same as its kind.
static SqlBasicAggFunction	create(String name, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeChecker operandTypeChecker) Creates a SqlBasicAggFunction.
RelDataType	deriveType(SqlValidator validator, SqlValidatorScope scope, SqlCall call) Derives the type of a call to this operator.
Optionality	getDistinctOptionality() Returns whether this aggregate function allows the DISTINCT keyword.
SqlOperandTypeChecker	getOperandTypeChecker()
SqlReturnTypeInference	getReturnTypeInference() Returns the return type inference strategy for this operator, or null if return type inference is implemented by a subclass override.
SqlSyntax	getSyntax() Returns the syntactic type of this operator, never null.
boolean	isPercentile() Returns whether this aggregate function is a PERCENTILE function.
SqlBasicAggFunction	withAllowsNullTreatment(boolean allowsNullTreatment) Sets allowsNullTreatment().
SqlBasicAggFunction	withAllowsSeparator(boolean allowsSeparator) Sets allowsSeparator().
SqlBasicAggFunction	withFunctionType(SqlFunctionCategory category) Sets SqlFunction.getFunctionType().
SqlBasicAggFunction	withGroupOrder(Optionality groupOrder) Sets SqlAggFunction.requiresGroupOrder().
SqlBasicAggFunction	withPercentile(boolean percentile) Sets isPercentile().
SqlBasicAggFunction	withSyntax(SqlSyntax syntax) Sets getSyntax().

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

allowsFilter, getParameterTypes, getReturnType, getRollup, isAggregator, isQuantifierAllowed, requiresGroupOrder, requiresOrder, requiresOver, unwrap, validateCall

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

getFunctionType, getNameAsId, getParamNames, getParamTypes, getSqlIdentifier, 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, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeInference, getRightPrec, getSignatureTemplate, 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

Method Detail

create

public static SqlBasicAggFunction create(SqlKind kind,
                                         SqlReturnTypeInference returnTypeInference,
                                         SqlOperandTypeChecker operandTypeChecker)

Creates a SqlBasicAggFunction whose name is the same as its kind.

create

public static SqlBasicAggFunction create(String name,
                                         SqlKind kind,
                                         SqlReturnTypeInference returnTypeInference,
                                         SqlOperandTypeChecker operandTypeChecker)

Creates a SqlBasicAggFunction.

deriveType

public RelDataType deriveType(SqlValidator validator,
                              SqlValidatorScope scope,
                              SqlCall call)

Description copied from class: SqlOperator

Derives the type of a call to this operator.

This method is an intrinsic part of the validation process so, unlike SqlOperator.inferReturnType(org.apache.calcite.sql.SqlOperatorBinding), specific operators would not typically override this method.

Overrides:

deriveType in class SqlFunction

Parameters:

validator - Validator

scope - Scope of validation

call - Call to this operator

Returns:

Type of call

getDistinctOptionality

public Optionality getDistinctOptionality()

Description copied from class: SqlAggFunction

Returns whether this aggregate function allows the DISTINCT keyword.

The default implementation returns Optionality.OPTIONAL, which is appropriate for most aggregate functions, including SUM and COUNT.

Some aggregate functions, for example MIN, produce the same result with or without DISTINCT, and therefore return Optionality.IGNORED to indicate this. For such functions, Calcite will probably remove DISTINCT while optimizing the query.

Overrides:

getDistinctOptionality in class SqlAggFunction

getReturnTypeInference

public SqlReturnTypeInference getReturnTypeInference()

Description copied from class: SqlOperator

Returns the return type inference strategy for this operator, or null if return type inference is implemented by a subclass override.

Overrides:

getReturnTypeInference in class SqlOperator

getOperandTypeChecker

public SqlOperandTypeChecker getOperandTypeChecker()

Overrides:

getOperandTypeChecker in class SqlOperator

withFunctionType

public SqlBasicAggFunction withFunctionType(SqlFunctionCategory category)

Sets SqlFunction.getFunctionType().

getSyntax

public SqlSyntax getSyntax()

Description copied from class: SqlOperator

Returns the syntactic type of this operator, never null.

Overrides:

getSyntax in class SqlFunction

withSyntax

public SqlBasicAggFunction withSyntax(SqlSyntax syntax)

Sets getSyntax().

allowsNullTreatment

public boolean allowsNullTreatment()

Description copied from class: SqlAggFunction

Returns whether this aggregate function allows specifying null treatment (RESPECT NULLS or IGNORE NULLS).

Overrides:

allowsNullTreatment in class SqlAggFunction

withAllowsNullTreatment

public SqlBasicAggFunction withAllowsNullTreatment(boolean allowsNullTreatment)

Sets allowsNullTreatment().

allowsSeparator

public boolean allowsSeparator()

Returns whether this aggregate function allows 'SEPARATOR string' among its arguments.

withAllowsSeparator

public SqlBasicAggFunction withAllowsSeparator(boolean allowsSeparator)

Sets allowsSeparator().

isPercentile

public boolean isPercentile()

Description copied from class: SqlAggFunction

Returns whether this aggregate function is a PERCENTILE function. Such functions require a WITHIN GROUP clause that has precisely one sort key.

NOTE: This API is experimental and subject to change without notice.

Overrides:

isPercentile in class SqlAggFunction

withPercentile

public SqlBasicAggFunction withPercentile(boolean percentile)

Sets isPercentile().

withGroupOrder

public SqlBasicAggFunction withGroupOrder(Optionality groupOrder)

Sets SqlAggFunction.requiresGroupOrder().