Package org.apache.calcite.sql

Class SqlNodeList

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlNodeList

All Implemented Interfaces:

Cloneable, Iterable<SqlNode>, Collection<SqlNode>, List<SqlNode>, RandomAccess

public class SqlNodeList
extends SqlNode
implements List<SqlNode>, RandomAccess

A SqlNodeList is a list of SqlNodes. It is also a SqlNode, so may appear in a parse tree.

See Also:

• SqlNode.toList()

Field Summary

Fields

Modifier and Type	Field	Description
static final SqlNodeList	EMPTY	An immutable, empty SqlNodeList.
static final SqlNodeList	SINGLETON_EMPTY	A SqlNodeList that has a single element that is an empty list.
static final SqlNodeList	SINGLETON_STAR	A SqlNodeList that has a single element that is a star identifier.

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

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor	Description
SqlNodeList(Collection<? extends @Nullable SqlNode> collection, SqlParserPos pos)	Creates a SqlNodeList containing the nodes in list.
SqlNodeList(SqlParserPos pos)	Creates a SqlNodeList that is initially empty.

Method Summary

Modifier and Type	Method	Description
<R> R	accept(SqlVisitor<R> visitor)	Accepts a generic visitor.
void	add(int index, @Nullable SqlNode element)
boolean	add(@Nullable SqlNode node)
boolean	addAll(int index, Collection<? extends @Nullable SqlNode> c)
boolean	addAll(Collection<? extends @Nullable SqlNode> c)
void	clear()
SqlNodeList	clone(SqlParserPos pos)	Clones a SqlNode with a different position.
boolean	contains(@Nullable Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(@Nullable Object o)
boolean	equalsDeep(@Nullable SqlNode node, Litmus litmus)	Returns whether this node is structurally equivalent to another node.
void	forEach(Consumer<? super SqlNode> action)
SqlNode	get(int n)
List<@Nullable SqlNode>	getList()
int	hashCode()
int	indexOf(@Nullable Object o)
boolean	isEmpty()
static boolean	isEmptyList(SqlNode node)
Iterator<SqlNode>	iterator()
int	lastIndexOf(@Nullable Object o)
ListIterator<SqlNode>	listIterator()
ListIterator<SqlNode>	listIterator(int index)
static SqlNodeList	of(SqlParserPos pos, List<@Nullable SqlNode> list)	Creates a SqlNodeList with a given backing list.
static SqlNodeList	of(SqlNode node1)
static SqlNodeList	of(SqlNode node1, SqlNode node2)
static SqlNodeList	of(SqlNode node1, SqlNode node2, @Nullable SqlNode... nodes)
SqlNode	remove(int index)
boolean	remove(@Nullable Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
SqlNode	set(int n, @Nullable SqlNode node)
int	size()
List<SqlNode>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> @Nullable T[]	toArray(T @Nullable [] a)
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.
void	validateExpr(SqlValidator validator, SqlValidatorScope scope)	Validates this node in an expression context.

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

clone, clone, cloneArray, equalDeep, equalDeep, equalsDeep, findValidOptions, getKind, getMonotonicity, getParserPosition, isA, toList, toList, toSqlString, toSqlString, toSqlString, toString, unparseWithParentheses

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Field Details

EMPTY

public static final SqlNodeList EMPTY

An immutable, empty SqlNodeList.

SINGLETON_EMPTY

public static final SqlNodeList SINGLETON_EMPTY

A SqlNodeList that has a single element that is an empty list.

SINGLETON_STAR

public static final SqlNodeList SINGLETON_STAR

A SqlNodeList that has a single element that is a star identifier.

Constructor Details

SqlNodeList

public SqlNodeList(SqlParserPos pos)

Creates a SqlNodeList that is initially empty.

SqlNodeList

public SqlNodeList(Collection<? extends @Nullable SqlNode> collection,
 SqlParserPos pos)

Creates a SqlNodeList containing the nodes in list. The list is copied, but the nodes in it are not.

Method Details

of

public static SqlNodeList of(SqlParserPos pos,
 List<@Nullable SqlNode> list)

Creates a SqlNodeList with a given backing list. Does not copy the list.

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<SqlNode>

Specified by:

hashCode in interface List<SqlNode>

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object o)

Specified by:

equals in interface Collection<SqlNode>

Specified by:

equals in interface List<SqlNode>

Overrides:

equals in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<SqlNode>

Specified by:

isEmpty in interface List<SqlNode>

size

public int size()

Specified by:

size in interface Collection<SqlNode>

Specified by:

size in interface List<SqlNode>

forEach

public void forEach(Consumer<? super SqlNode> action)

Specified by:

forEach in interface Iterable<SqlNode>

iterator

public Iterator<SqlNode> iterator()

Specified by:

iterator in interface Collection<SqlNode>

Specified by:

iterator in interface Iterable<SqlNode>

Specified by:

iterator in interface List<SqlNode>

listIterator

public ListIterator<SqlNode> listIterator()

Specified by:

listIterator in interface List<SqlNode>

listIterator

public ListIterator<SqlNode> listIterator(int index)

Specified by:

listIterator in interface List<SqlNode>

subList

public List<SqlNode> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<SqlNode>

get

public SqlNode get(int n)

Specified by:

get in interface List<SqlNode>

set

public SqlNode set(int n,
 @Nullable SqlNode node)

Specified by:

set in interface List<SqlNode>

contains

public boolean contains(@Nullable Object o)

Specified by:

contains in interface Collection<SqlNode>

Specified by:

contains in interface List<SqlNode>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<SqlNode>

Specified by:

containsAll in interface List<SqlNode>

indexOf

public int indexOf(@Nullable Object o)

Specified by:

indexOf in interface List<SqlNode>

lastIndexOf

public int lastIndexOf(@Nullable Object o)

Specified by:

lastIndexOf in interface List<SqlNode>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<SqlNode>

Specified by:

toArray in interface List<SqlNode>

toArray

public <T> @Nullable T[] toArray(T @Nullable [] a)

Specified by:

toArray in interface Collection<SqlNode>

Specified by:

toArray in interface List<SqlNode>

add

public boolean add(@Nullable SqlNode node)

Specified by:

add in interface Collection<SqlNode>

Specified by:

add in interface List<SqlNode>

add

public void add(int index,
 @Nullable SqlNode element)

Specified by:

add in interface List<SqlNode>

addAll

public boolean addAll(Collection<? extends @Nullable SqlNode> c)

Specified by:

addAll in interface Collection<SqlNode>

Specified by:

addAll in interface List<SqlNode>

addAll

public boolean addAll(int index,
 Collection<? extends @Nullable SqlNode> c)

Specified by:

addAll in interface List<SqlNode>

clear

public void clear()

Specified by:

clear in interface Collection<SqlNode>

Specified by:

clear in interface List<SqlNode>

remove

public boolean remove(@Nullable Object o)

Specified by:

remove in interface Collection<SqlNode>

Specified by:

remove in interface List<SqlNode>

remove

public SqlNode remove(int index)

Specified by:

remove in interface List<SqlNode>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<SqlNode>

Specified by:

removeAll in interface List<SqlNode>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<SqlNode>

Specified by:

retainAll in interface List<SqlNode>

getList

public List<@Nullable SqlNode> getList()

clone

public SqlNodeList clone(SqlParserPos pos)

Description copied from class: SqlNode

Clones a SqlNode with a different position.

Specified by:

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

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

Parameters:

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(@Nullable SqlNode node,
 Litmus litmus)

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

isEmptyList

public static boolean isEmptyList(SqlNode node)

of

public static SqlNodeList of(SqlNode node1)

of

public static SqlNodeList of(SqlNode node1,
 SqlNode node2)

of

public static SqlNodeList of(SqlNode node1,
 SqlNode node2,
 @Nullable SqlNode... nodes)

validateExpr

public void validateExpr(SqlValidator validator,
 SqlValidatorScope scope)

Description copied from class: SqlNode

Validates this node in an expression context.

Usually, this method does much the same as SqlNode.validate(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope), but a SqlIdentifier can occur in expression and non-expression contexts.

Overrides:

validateExpr in class SqlNode