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 and Description
SqlFloorFunction(SqlKind kind)

Method Summary

Modifier and Type	Method and Description
SqlMonotonicity	getMonotonicity(SqlOperatorBinding call) Returns whether a call to this operator is monotonic.
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.

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

deriveType, getFunctionType, getNameAsId, getParamNames, getParamTypes, getSqlIdentifier, getSyntax, isQuantifierAllowed, validateCall, validateQuantifier

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

acceptCall, acceptCall, adjustType, allowsFraming, argumentMustBeScalar, checkOperandCount, checkOperandTypes, constructArgNameList, constructArgTypeList, constructOperandList, createCall, createCall, createCall, createCall, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, leftPrec, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlFloorFunction

public SqlFloorFunction(SqlKind kind)

Method Detail

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

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