org.apache.calcite.sql.fun

Class SqlBetweenOperator

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlSpecialOperator

org.apache.calcite.sql.SqlInfixOperator

org.apache.calcite.sql.fun.SqlBetweenOperator

public class SqlBetweenOperator
extends SqlInfixOperator

Defines the BETWEEN operator.

Syntax:

X [NOT] BETWEEN [ASYMMETRIC | SYMMETRIC] Y AND Z

If the asymmetric/symmetric keywords are left out ASYMMETRIC is default.

This operator is always expanded (into something like Y <= X AND X <= Z) before being converted into Rex nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlBetweenOperator.Flag Defines the "SYMMETRIC" and "ASYMMETRIC" keywords.

Nested classes/interfaces inherited from class org.apache.calcite.sql.SqlSpecialOperator

SqlSpecialOperator.ReduceResult, SqlSpecialOperator.TokenSequence

Field Summary

Fields

Modifier and Type	Field and Description
SqlBetweenOperator.Flag	flag
static int	LOWER_OPERAND Ordinal of the 'lower' operand.
static int	UPPER_OPERAND Ordinal of the 'upper' operand.
static int	VALUE_OPERAND Ordinal of the 'value' operand.

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor and Description
SqlBetweenOperator(SqlBetweenOperator.Flag flag, boolean negated)

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getSignatureTemplate(int operandsCount) Returns a template describing how the operator signature is to be built.
RelDataType	inferReturnType(SqlOperatorBinding opBinding) Infers the return type of an invocation of this operator; only called after the number and types of operands have already been validated.
boolean	isNegated() Returns whether this is 'NOT' variant of an operator.
SqlOperator	not() Returns the operator that is the logical inverse of this operator.
SqlSpecialOperator.ReduceResult	reduceExpr(int opOrdinal, SqlSpecialOperator.TokenSequence list) Reduces a list of operators and arguments according to the rules of precedence and associativity.
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.
boolean	validRexOperands(int count, Litmus litmus) Returns whether the given operands are valid.

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

getSyntax

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, deriveType, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getNameAsId, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getStrongPolicyInference, hashCode, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, reverse, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateCall, validateOperands

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_OPERAND

public static final int VALUE_OPERAND

Ordinal of the 'value' operand.

See Also:

Constant Field Values

LOWER_OPERAND

public static final int LOWER_OPERAND

Ordinal of the 'lower' operand.

See Also:

Constant Field Values

UPPER_OPERAND

public static final int UPPER_OPERAND

Ordinal of the 'upper' operand.

See Also:

Constant Field Values

flag

public final SqlBetweenOperator.Flag flag

Constructor Detail

SqlBetweenOperator

public SqlBetweenOperator(SqlBetweenOperator.Flag flag,
                          boolean negated)

Method Detail

validRexOperands

public boolean validRexOperands(int count,
                                Litmus litmus)

Description copied from class: SqlOperator

Returns whether the given operands are valid. If not valid and fail, throws an assertion error.

Similar to SqlOperator.checkOperandCount(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.type.SqlOperandTypeChecker, org.apache.calcite.sql.SqlCall), but some operators may have different valid operands in SqlNode and RexNode formats (some examples are CAST and AND), and this method throws internal errors, not user errors.

Overrides:

validRexOperands in class SqlOperator

isNegated

public boolean isNegated()

Returns whether this is 'NOT' variant of an operator.

See Also:

not()

not

public SqlOperator not()

Description copied from class: SqlOperator

Returns the operator that is the logical inverse of this operator.

For example, SqlStdOperatorTable.LIKE.not() returns SqlStdOperatorTable.NOT_LIKE, and vice versa.

By default, returns null, which means there is no inverse operator.

Overrides:

not in class SqlOperator

See Also:

SqlOperator.reverse()

inferReturnType

public RelDataType inferReturnType(SqlOperatorBinding opBinding)

Description copied from class: SqlOperator

Infers the return type of an invocation of this operator; only called after the number and types of operands have already been validated. Subclasses must either override this method or supply an instance of SqlReturnTypeInference to the constructor.

Overrides:

inferReturnType in class SqlOperator

Parameters:

opBinding - description of invocation (not necessarily a SqlCall)

Returns:

inferred return type

getSignatureTemplate

public String getSignatureTemplate(int operandsCount)

Description copied from class: SqlOperator

Returns a template describing how the operator signature is to be built. E.g for the binary + operator the template looks like "{1} {0} {2}" {0} is the operator, subsequent numbers are operands.

Overrides:

getSignatureTemplate in class SqlOperator

Parameters:

operandsCount - is used with functions that can take a variable number of operands

Returns:

signature template, or null to indicate that a default template will suffice

getName

public String getName()

Overrides:

getName in class SqlOperator

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 SqlInfixOperator

reduceExpr

public SqlSpecialOperator.ReduceResult reduceExpr(int opOrdinal,
                                                  SqlSpecialOperator.TokenSequence list)

Description copied from class: SqlSpecialOperator

Reduces a list of operators and arguments according to the rules of precedence and associativity. Returns the ordinal of the node which replaced the expression.

The default implementation throws UnsupportedOperationException.

Overrides:

reduceExpr in class SqlSpecialOperator

Parameters:

opOrdinal - indicating the ordinal of the current operator in the list on which a possible reduction can be made

list - List of alternating SqlParserUtil.ToTreeListItem and SqlNode

Returns:

ordinal of the node which replaced the expression