org.apache.calcite.sql

Class SqlIntervalQualifier

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlIntervalQualifier

All Implemented Interfaces:

Cloneable

public class SqlIntervalQualifier
extends SqlNode

Represents an INTERVAL qualifier.

INTERVAL qualifier is defined as follows:

<interval qualifier> ::=
<start field> TO <end field>
| <single datetime field>
<start field> ::=
<non-second primary datetime field>
[ <left paren> <interval leading field precision> <right paren> ]
<end field> ::=
<non-second primary datetime field>
| SECOND [ <left paren> <interval fractional seconds precision> <right paren> ]
<single datetime field> ::=
<non-second primary datetime field>
[ <left paren> <interval leading field precision> <right paren> ]
| SECOND [ <left paren> <interval leading field precision>
[ <comma> <interval fractional seconds precision> ] <right paren> ]
<primary datetime field> ::=
<non-second primary datetime field>
| SECOND
<non-second primary datetime field> ::= YEAR | MONTH | DAY | HOUR | MINUTE
<interval fractional seconds precision> ::= <unsigned integer>
<interval leading field precision> ::= <unsigned integer>

Examples include:

• INTERVAL '1:23:45.678' HOUR TO SECOND
• INTERVAL '1 2:3:4' DAY TO SECOND
• INTERVAL '1 2:3:4' DAY(4) TO SECOND(4)

An instance of this class is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
TimeUnitRange	timeUnitRange

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

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor and Description
SqlIntervalQualifier(TimeUnit startUnit, int startPrecision, TimeUnit endUnit, int fractionalSecondPrecision, SqlParserPos pos)
SqlIntervalQualifier(TimeUnit startUnit, TimeUnit endUnit, SqlParserPos pos)

Method Summary

Methods

Modifier and Type	Method and Description
<R> R	accept(SqlVisitor<R> visitor) Accepts a generic visitor.
SqlNode	clone(SqlParserPos pos) Clones a SqlNode with a different position.
static int	combineFractionalSecondPrecisionPreservingDefault(RelDataTypeSystem typeSystem, SqlIntervalQualifier qual1, SqlIntervalQualifier qual2)
static int	combineStartPrecisionPreservingDefault(RelDataTypeSystem typeSystem, SqlIntervalQualifier qual1, SqlIntervalQualifier qual2)
boolean	equalsDeep(SqlNode node, boolean fail) Returns whether this node is structurally equivalent to another node.
int[]	evaluateIntervalLiteral(String value, SqlParserPos pos, RelDataTypeSystem typeSystem) Validates an INTERVAL literal according to the rules specified by the interval qualifier.
TimeUnit	getEndUnit()
int	getFractionalSecondPrecision(RelDataTypeSystem typeSystem)
int	getFractionalSecondPrecisionPreservingDefault()
int	getStartPrecision(RelDataTypeSystem typeSystem)
int	getStartPrecisionPreservingDefault()
TimeUnit	getStartUnit()
boolean	isSingleDatetimeField() Does this interval have a single datetime field Return true not of form unit TO unit.
boolean	isYearMonth()
SqlTypeName	typeName()
void	unparse(RelDataTypeSystem typeSystem, SqlWriter writer)
void	unparse(SqlWriter writer, int leftPrec, int rightPrec) Writes a SQL representation of this node to a writer.
void	validate(SqlValidator validator, SqlValidatorScope scope) Validates this node.

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

clone, cloneArray, equalDeep, equalDeep, findValidOptions, getKind, getMonotonicity, getParserPosition, isA, toSqlString, toSqlString, toString, validateExpr

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

timeUnitRange

public final TimeUnitRange timeUnitRange

Constructor Detail

SqlIntervalQualifier

public SqlIntervalQualifier(TimeUnit startUnit,
                    int startPrecision,
                    TimeUnit endUnit,
                    int fractionalSecondPrecision,
                    SqlParserPos pos)

SqlIntervalQualifier

public SqlIntervalQualifier(TimeUnit startUnit,
                    TimeUnit endUnit,
                    SqlParserPos pos)

Method Detail

typeName

public SqlTypeName typeName()

validate

public void validate(SqlValidator validator,
            SqlValidatorScope scope)

Description copied from class: SqlNode

Validates this node.

The typical implementation of this method will make a callback to the validator appropriate to the node type and context. The validator has methods such as SqlValidator.validateLiteral(org.apache.calcite.sql.SqlLiteral) for these purposes.

Specified by:

validate in class SqlNode

scope - Validator

accept

public <R> R accept(SqlVisitor<R> visitor)

Description copied from class: SqlNode

Accepts a generic visitor.

Implementations of this method in subtypes simply call the appropriate visit method on the visitor object.

The type parameter R must be consistent with the type parameter of the visitor.

Specified by:

accept in class SqlNode

equalsDeep

public boolean equalsDeep(SqlNode node,
                 boolean fail)

Description copied from class: SqlNode

Returns whether this node is structurally equivalent to another node. Some examples:

• 1 + 2 is structurally equivalent to 1 + 2
• 1 + 2 + 3 is structurally equivalent to (1 + 2) + 3, but not to 1 + (2 + 3), because the '+' operator is left-associative

Specified by:

equalsDeep in class SqlNode

getStartPrecision

public int getStartPrecision(RelDataTypeSystem typeSystem)

getStartPrecisionPreservingDefault

public int getStartPrecisionPreservingDefault()

combineStartPrecisionPreservingDefault

public static int combineStartPrecisionPreservingDefault(RelDataTypeSystem typeSystem,
                                         SqlIntervalQualifier qual1,
                                         SqlIntervalQualifier qual2)

getFractionalSecondPrecision

public int getFractionalSecondPrecision(RelDataTypeSystem typeSystem)

getFractionalSecondPrecisionPreservingDefault

public int getFractionalSecondPrecisionPreservingDefault()

combineFractionalSecondPrecisionPreservingDefault

public static int combineFractionalSecondPrecisionPreservingDefault(RelDataTypeSystem typeSystem,
                                                    SqlIntervalQualifier qual1,
                                                    SqlIntervalQualifier qual2)

getStartUnit

public TimeUnit getStartUnit()

getEndUnit

public TimeUnit getEndUnit()

clone

public SqlNode clone(SqlParserPos pos)

Description copied from class: SqlNode

Clones a SqlNode with a different position.

Overrides:

clone in class SqlNode

unparse

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

Description copied from class: SqlNode

Writes a SQL representation of this node to a writer.

The leftPrec and rightPrec parameters give us enough context to decide whether we need to enclose the expression in parentheses. For example, we need parentheses around "2 + 3" if preceded by "5 *". This is because the precedence of the "*" operator is greater than the precedence of the "+" operator.

The algorithm handles left- and right-associative operators by giving them slightly different left- and right-precedence.

If SqlWriter.isAlwaysUseParentheses() is true, we use parentheses even when they are not required by the precedence rules.

For the details of this algorithm, see SqlCall.unparse(org.apache.calcite.sql.SqlWriter, int, int).

Specified by:

unparse in class SqlNode

Parameters:

writer - Target writer

leftPrec - The precedence of the SqlNode immediately preceding this node in a depth-first scan of the parse tree

rightPrec - The precedence of the SqlNode immediately

unparse

public void unparse(RelDataTypeSystem typeSystem,
           SqlWriter writer)

isSingleDatetimeField

public boolean isSingleDatetimeField()

Does this interval have a single datetime field Return true not of form unit TO unit.

isYearMonth

public final boolean isYearMonth()

evaluateIntervalLiteral

public int[] evaluateIntervalLiteral(String value,
                            SqlParserPos pos,
                            RelDataTypeSystem typeSystem)

Validates an INTERVAL literal according to the rules specified by the interval qualifier. The assumption is made that the interval qualifier has been validated prior to calling this method. Evaluating against an invalid qualifier could lead to strange results.

Returns:

field values, never null

Throws:

CalciteContextException - if the interval value is illegal