org.apache.calcite.sql

Class SqlRankFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.SqlAggFunction

org.apache.calcite.sql.SqlRankFunction

public class SqlRankFunction
extends SqlAggFunction

Operator which aggregates sets of values into a result.

Field Summary

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor and Description
SqlRankFunction(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsFraming() Returns whether this is a window function that allows framing (i.e.
List<RelDataType>	getParameterTypes(RelDataTypeFactory typeFactory)
RelDataType	getReturnType(RelDataTypeFactory typeFactory)
boolean	requiresOrder() Returns whether this is a window function that requires ordering.

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

isAggregator, isQuantifierAllowed, validateCall

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

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

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

acceptCall, acceptCall, adjustType, argumentMustBeScalar, checkOperandCount, checkOperandTypes, createCall, createCall, createCall, createCall, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, hashCode, inferReturnType, inferReturnType, isDeterministic, isDynamicFunction, isName, leftPrec, preValidateCall, requiresDecimalExpansion, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlRankFunction

public SqlRankFunction(String name)

Method Detail

requiresOrder

public boolean requiresOrder()

Description copied from class: SqlOperator

Returns whether this is a window function that requires ordering.

Per SQL:2011, 2, 6.10: "If <ntile function>, <lead or lag function>, RANK or DENSE_RANK is specified, then the window ordering clause shall be present."

Overrides:

requiresOrder in class SqlOperator

See Also:

SqlOperator.isAggregator()

allowsFraming

public boolean allowsFraming()

Description copied from class: SqlOperator

Returns whether this is a window function that allows framing (i.e. a ROWS or RANGE clause in the window specification).

Overrides:

allowsFraming in class SqlOperator

getReturnType

public RelDataType getReturnType(RelDataTypeFactory typeFactory)

getParameterTypes

public List<RelDataType> getParameterTypes(RelDataTypeFactory typeFactory)