Package org.apache.calcite.sql.fun

Class SqlFloorFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.fun.SqlMonotonicUnaryFunction

org.apache.calcite.sql.fun.SqlFloorFunction

public class SqlFloorFunction
extends SqlMonotonicUnaryFunction

Definition of the "FLOOR" and "CEIL" built-in SQL functions.

Field Summary

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlFloorFunction(SqlKind kind)

Method Summary

Modifier and Type	Method	Description
RelDataType	deriveType(SqlValidator validator, SqlValidatorScope scope, SqlCall call)	Derives the type of a call to this operator.
SqlMonotonicity	getMonotonicity(SqlOperatorBinding call)	Returns whether a call to this operator is monotonic.
String	getName()
static SqlCall	replaceTimeUnitOperand(SqlCall call, String literal, SqlParserPos pos)	Copies a SqlCall, replacing the time unit operand with the given literal.
void	unparse(SqlWriter writer, SqlCall call, int leftPrec, int rightPrec)	Writes a SQL representation of a call to this operator to a writer, including parentheses if the operators on either side are of greater precedence.
static void	unparseDatetimeFunction(SqlWriter writer, SqlCall call, String funName, Boolean datetimeFirst)	Most dialects that natively support datetime floor will use this.
void	validateCall(SqlCall call, SqlValidator validator, SqlValidatorScope scope, SqlValidatorScope operandScope)	Validates a call to this operator.
SqlFloorFunction	withName(String name)
SqlFloorFunction	withReturnTypeInference(SqlReturnTypeInference returnTypeInference)

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

getFunctionType, getNameAsId, getParamNames, getParamTypes, getSqlIdentifier, getSyntax, isQuantifierAllowed, 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, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, getSqlCallFactory, getStrongPolicyInference, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, not, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, reverse, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Constructor Details

SqlFloorFunction

public SqlFloorFunction(SqlKind kind)

Method Details

withName

public SqlFloorFunction withName(String name)

withReturnTypeInference

public SqlFloorFunction withReturnTypeInference(SqlReturnTypeInference returnTypeInference)

getMonotonicity

public SqlMonotonicity getMonotonicity(SqlOperatorBinding call)

Description copied from class: SqlOperator

Returns whether a call to this operator is monotonic.

Default implementation returns SqlMonotonicity.NOT_MONOTONIC.

Overrides:

getMonotonicity in class SqlMonotonicUnaryFunction

Parameters:

call - Call to this operator with particular arguments and information about the monotonicity of the arguments

unparse

public void unparse(SqlWriter writer,
 SqlCall call,
 int leftPrec,
 int rightPrec)

Description copied from class: SqlOperator

Writes a SQL representation of a call to this operator to a writer, including parentheses if the operators on either side are of greater precedence.

The default implementation of this method delegates to SqlSyntax.unparse(org.apache.calcite.sql.SqlWriter, org.apache.calcite.sql.SqlOperator, org.apache.calcite.sql.SqlCall, int, int).

Overrides:

unparse in class SqlFunction

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

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 SqlFunction

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)

getName

public String getName()

Overrides:

getName in class SqlOperator

replaceTimeUnitOperand

public static SqlCall replaceTimeUnitOperand(SqlCall call,
 String literal,
 SqlParserPos pos)

Copies a SqlCall, replacing the time unit operand with the given literal.

Parameters:

call - Call

literal - Literal to replace time unit with

pos - Parser position

Returns:

Modified call

unparseDatetimeFunction

public static void unparseDatetimeFunction(SqlWriter writer,
 SqlCall call,
 String funName,
 Boolean datetimeFirst)

Most dialects that natively support datetime floor will use this. In those cases the call will look like TRUNC(datetime, 'year').

Parameters:

writer - SqlWriter

call - SqlCall

funName - Name of the sql function to call

datetimeFirst - Specify the order of the datetime & timeUnit arguments