Package org.apache.calcite.sql.fun

Class SqlMinMaxAggFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.SqlAggFunction

org.apache.calcite.sql.fun.SqlMinMaxAggFunction

All Implemented Interfaces:

Context, Wrapper

public class SqlMinMaxAggFunction
extends SqlAggFunction

Definition of the MIN and MAX aggregate functions, returning the returns the smallest/largest of the values which go into it.

There are 3 forms:

min/max(primitive type)

values are compared using '<'

min/max(Comparable)

values are compared using Comparable.compareTo(T)

min/max(Comparator, Object)

the Comparator.compare(T, T) method of the comparator is used to compare pairs of objects. The comparator is a startup argument, and must therefore be constant for the duration of the aggregation.

Field Summary

Fields

Modifier and Type	Field	Description
final List<RelDataType>	argTypes	Deprecated.
static final int	MINMAX_COMPARABLE
static final int	MINMAX_COMPARATOR
static final int	MINMAX_INVALID
static final int	MINMAX_PRIMITIVE

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlMinMaxAggFunction(String funcName, SqlKind kind, SqlOperandTypeChecker inputTypeChecker)	Creates a SqlMinMaxAggFunction.
SqlMinMaxAggFunction(List<RelDataType> argTypes, boolean isMin, int minMaxKind)	Deprecated.
SqlMinMaxAggFunction(SqlKind kind)	Creates a SqlMinMaxAggFunction.

Method Summary

Modifier and Type	Method	Description
Optionality	getDistinctOptionality()	Returns whether this aggregate function allows the DISTINCT keyword.
int	getMinMaxKind()	Deprecated.
List<RelDataType>	getParameterTypes(RelDataTypeFactory typeFactory)
RelDataType	getReturnType(RelDataTypeFactory typeFactory)
SqlAggFunction	getRollup()	Gets rollup aggregation function.
boolean	isMin()	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

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

Field Details

MINMAX_INVALID

public static final int MINMAX_INVALID

See Also:

• Constant Field Values

MINMAX_PRIMITIVE

public static final int MINMAX_PRIMITIVE

See Also:

• Constant Field Values

MINMAX_COMPARABLE

public static final int MINMAX_COMPARABLE

See Also:

• Constant Field Values

MINMAX_COMPARATOR

public static final int MINMAX_COMPARATOR

See Also:

• Constant Field Values

argTypes

@Deprecated
public final List<RelDataType> argTypes

Deprecated.

Constructor Details

SqlMinMaxAggFunction

public SqlMinMaxAggFunction(SqlKind kind)

Creates a SqlMinMaxAggFunction.

SqlMinMaxAggFunction

public SqlMinMaxAggFunction(String funcName,
 SqlKind kind,
 SqlOperandTypeChecker inputTypeChecker)

Creates a SqlMinMaxAggFunction.

SqlMinMaxAggFunction

@Deprecated
public SqlMinMaxAggFunction(List<RelDataType> argTypes,
 boolean isMin,
 int minMaxKind)

Deprecated.

Method Details

isMin

@Deprecated
public boolean isMin()

Deprecated.

getMinMaxKind

@Deprecated
public int getMinMaxKind()

Deprecated.

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

getParameterTypes

public List<RelDataType> getParameterTypes(RelDataTypeFactory typeFactory)

Overrides:

getParameterTypes in class SqlAggFunction

getReturnType

public RelDataType getReturnType(RelDataTypeFactory typeFactory)

Overrides:

getReturnType in class SqlAggFunction

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

getRollup

public SqlAggFunction getRollup()

Description copied from class: SqlAggFunction

Gets rollup aggregation function.

Overrides:

getRollup in class SqlAggFunction