org.eclipse.persistence.jpa.internal.jpql.parser

Class CollectionMemberDeclaration

java.lang.Object

org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression

org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

org.eclipse.persistence.jpa.internal.jpql.parser.CollectionMemberDeclaration

All Implemented Interfaces:

Expression

public final class CollectionMemberDeclaration
extends AbstractExpression

An identification variable declared by a collection member declaration ranges over values of a collection obtained by navigation using a path expression. Such a path expression represents a navigation involving the association-fields of an entity abstract schema type. Because a path expression can be based on another path expression, the navigation can use the association-fields of related entities. An identification variable of a collection member declaration is declared using a special operator, the reserved identifier IN. The argument to the IN operator is a collection-valued path expression. The path expression evaluates to a collection type specified as a result of navigation to a collection-valued association-field of an entity abstract schema type.

BNF: collection_member_declaration ::= IN(collection_valued_path_expression) [AS] identification_variable

or

BNF: derived_collection_member_declaration ::= IN superquery_identification_variable.{single_valued_object_field.}*collection_valued_field

Example: SELECT t FROM Player p, IN (p.teams) AS t

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE

Fields inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
Expression	getCollectionValuedPathExpression() Returns the Expression representing the collection member, which is declared by an identification variable.
Expression	getIdentificationVariable() Returns the Expression representing the identification variable, which maps the collection-valued path expression.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
boolean	hasAs() Determines whether the identifier AS was parsed.
boolean	hasCollectionValuedPathExpression() Determines whether the collection-valued path expression was parsed.
boolean	hasIdentificationVariable() Determines whether the identification variable was parsed.
boolean	hasLeftParenthesis() Determines whether the open parenthesis was parsed or not.
boolean	hasRightParenthesis() Determines whether the close parenthesis was parsed or not.
boolean	hasSpaceAfterAs() Determines whether a whitespace was found after AS.
boolean	hasSpaceAfterIn() Determines whether a whitespace was found after IN.
boolean	hasSpaceAfterRightParenthesis() Determines whether a whitespace was found after the close parenthesis.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

children, findQueryBNF, getChildren, getParent, getRoot, identifierRole, identifiers, identifierVersion, isAncestor, isIdentifier, isVirtual, orderedChildren, queryBNF, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

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

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The visitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() or Expression.getChildren() is called.

This does not traverse the Expression sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters:

visitor - The visitor to visit the children of this object.

getCollectionValuedPathExpression

public Expression getCollectionValuedPathExpression()

Returns the Expression representing the collection member, which is declared by an identification variable.

Returns:

The expression representing the collection-valued path expression

getIdentificationVariable

public Expression getIdentificationVariable()

Returns the Expression representing the identification variable, which maps the collection-valued path expression.

Returns:

The expression representing the identification variable

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

hasAs

public boolean hasAs()

Determines whether the identifier AS was parsed.

Returns:

true if the identifier AS was parsed; false otherwise

hasCollectionValuedPathExpression

public boolean hasCollectionValuedPathExpression()

Determines whether the collection-valued path expression was parsed.

Returns:

true if the query has the collection-valued path expression; false otherwise

hasIdentificationVariable

public boolean hasIdentificationVariable()

Determines whether the identification variable was parsed.

Returns:

true if the query has the identification variable; false otherwise

hasLeftParenthesis

public boolean hasLeftParenthesis()

Determines whether the open parenthesis was parsed or not.

Returns:

true if the open parenthesis was present in the string version of the query; false otherwise

hasRightParenthesis

public boolean hasRightParenthesis()

Determines whether the close parenthesis was parsed or not.

Returns:

true if the close parenthesis was present in the string version of the query; false otherwise

hasSpaceAfterAs

public boolean hasSpaceAfterAs()

Determines whether a whitespace was found after AS.

Returns:

true if there was a whitespace after AS; false otherwise

hasSpaceAfterIn

public boolean hasSpaceAfterIn()

Determines whether a whitespace was found after IN.

Returns:

true if there was a whitespace after IN; false otherwise

hasSpaceAfterRightParenthesis

public boolean hasSpaceAfterRightParenthesis()

Determines whether a whitespace was found after the close parenthesis.

Returns:

true if there was a whitespace after the right parenthesis; false otherwise