Package org.apache.calcite.sql.fun

Class SqlSingleValueAggFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.SqlAggFunction

org.apache.calcite.sql.fun.SqlSingleValueAggFunction

All Implemented Interfaces:

Context, Wrapper

public class SqlSingleValueAggFunction
extends SqlAggFunction

SINGLE_VALUE aggregate function returns the input value if there is only one value in the input; Otherwise it triggers a run-time error.

Field Summary

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlSingleValueAggFunction(RelDataType type)

Method Summary

Modifier and Type	Method	Description
boolean	allowsFilter()	Whether this aggregate function allows a FILTER (WHERE ...) clause.
Optionality	getDistinctOptionality()	Returns whether this aggregate function allows the DISTINCT keyword.
List<RelDataType>	getParameterTypes(RelDataTypeFactory typeFactory)
RelDataType	getReturnType(RelDataTypeFactory typeFactory)
SqlAggFunction	getRollup()	Gets rollup aggregation function.
RelDataType	getType()	Deprecated.
<T> @Nullable T	unwrap(Class<T> clazz)	Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

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

allowsNullTreatment, isAggregator, isPercentile, isQuantifierAllowed, requiresGroupOrder, requiresOrder, requiresOver, validateCall

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

SqlSingleValueAggFunction

public SqlSingleValueAggFunction(RelDataType type)

Method Details

allowsFilter

public boolean allowsFilter()

Description copied from class: SqlAggFunction

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

Overrides:

allowsFilter in class SqlAggFunction

getParameterTypes

public List<RelDataType> getParameterTypes(RelDataTypeFactory typeFactory)

Overrides:

getParameterTypes in class SqlAggFunction

getReturnType

public RelDataType getReturnType(RelDataTypeFactory typeFactory)

Overrides:

getReturnType in class SqlAggFunction

getType

@Deprecated
public RelDataType getType()

Deprecated.

unwrap

public <T> @Nullable T unwrap(Class<T> clazz)

Description copied from interface: Wrapper

Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

Specified by:

unwrap in interface Wrapper

Overrides:

unwrap in class SqlAggFunction

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

getRollup

public SqlAggFunction getRollup()

Description copied from class: SqlAggFunction

Gets rollup aggregation function.

Overrides:

getRollup in class SqlAggFunction