Class CollectionMemberDeclaration
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.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:orcollection_member_declaration ::= IN(collection_valued_path_expression) [AS] identification_variableBNF:derived_collection_member_declaration ::= IN superquery_identification_variable.{single_valued_object_field.}*collection_valued_fieldExample:
SELECT t FROM Player p, IN (p.teams) AS t- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.3
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.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.jpql.parser.Expression
ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, 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_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
-
Constructor Summary
Constructors Constructor Description CollectionMemberDeclaration(AbstractExpression parent)Creates a newCollectionMemberDeclaration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.java.lang.StringgetActualAsIdentifier()Returns the actual AS identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualInIdentifier()Returns the actual IN identifier found in the string representation of the JPQL query, which has the actual case that was used.ExpressiongetCollectionValuedPathExpression()Returns theExpressionrepresenting the collection member, which is declared by an identification variable.ExpressiongetIdentificationVariable()Returns theExpressionrepresenting the identification variable, which maps the collection-valued path expression.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.booleanhasAs()Determines whether the identifier AS was parsed.booleanhasCollectionValuedPathExpression()Determines whether the collection-valued path expression was parsed.booleanhasIdentificationVariable()Determines whether the identification variable was parsed.booleanhasLeftParenthesis()Determines whether the open parenthesis was parsed or not.booleanhasRightParenthesis()Determines whether the close parenthesis was parsed or not.booleanhasSpaceAfterAs()Determines whether a whitespace was found after AS.booleanhasSpaceAfterIn()Determines whether a whitespace was found after IN.booleanhasSpaceAfterRightParenthesis()Determines whether a whitespace was found after the close parenthesis.booleanisDerived()Determines whether this collection member declaration is used as a derived collection-valued path expression.protected booleanisParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)Determines whether the parsing is complete based on what is left in the given text.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.java.lang.StringtoParsedTextUntilAs()Creates a string representation of this expression up and excluding the AS identifier.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
CollectionMemberDeclaration
public CollectionMemberDeclaration(AbstractExpression parent)
Creates a newCollectionMemberDeclaration.- Parameters:
parent- The parent of this expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()is called.This does not traverse the
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getActualAsIdentifier
public java.lang.String getActualAsIdentifier()
Returns the actual AS identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The AS identifier that was actually parsed
-
getActualInIdentifier
public java.lang.String getActualInIdentifier()
Returns the actual IN identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The IN identifier that was actually parsed
-
getCollectionValuedPathExpression
public Expression getCollectionValuedPathExpression()
Returns theExpressionrepresenting the collection member, which is declared by an identification variable.- Returns:
- The expression representing the collection-valued path expression
-
getIdentificationVariable
public Expression getIdentificationVariable()
Returns theExpressionrepresenting 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 thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
hasAs
public boolean hasAs()
Determines whether the identifier AS was parsed.- Returns:
trueif the identifier AS was parsed;falseotherwise
-
hasCollectionValuedPathExpression
public boolean hasCollectionValuedPathExpression()
Determines whether the collection-valued path expression was parsed.- Returns:
trueif the query has the collection-valued path expression;falseotherwise
-
hasIdentificationVariable
public boolean hasIdentificationVariable()
Determines whether the identification variable was parsed.- Returns:
trueif the query has the identification variable;falseotherwise
-
hasLeftParenthesis
public boolean hasLeftParenthesis()
Determines whether the open parenthesis was parsed or not.- Returns:
trueif the open parenthesis was present in the string version of the query;falseotherwise
-
hasRightParenthesis
public boolean hasRightParenthesis()
Determines whether the close parenthesis was parsed or not.- Returns:
trueif the close parenthesis was present in the string version of the query;falseotherwise
-
hasSpaceAfterAs
public boolean hasSpaceAfterAs()
Determines whether a whitespace was found after AS.- Returns:
trueif there was a whitespace after AS;falseotherwise
-
hasSpaceAfterIn
public boolean hasSpaceAfterIn()
Determines whether a whitespace was found after IN.- Returns:
trueif there was a whitespace after IN;falseotherwise
-
hasSpaceAfterRightParenthesis
public boolean hasSpaceAfterRightParenthesis()
Determines whether a whitespace was found after the close parenthesis.- Returns:
trueif there was a whitespace after the right parenthesis;falseotherwise
-
isDerived
public boolean isDerived()
Determines whether this collection member declaration is used as a derived collection-valued path expression.- Returns:
trueif this collection member declaration is used as this form: "IN collection_valued_path_expression" in a subquery;falseif it's used as this form:IN(collection_valued_path_expression) [AS] identification_variable" in a top-level or subquery queries- Since:
- 2.4
-
isParsingComplete
protected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
Determines whether the parsing is complete based on what is left in the given text. The text is never empty.- Overrides:
isParsingCompletein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursorword- The word that was retrieved from the given text, which is the first word in the textexpression- TheExpressionthat has already been parsed- Returns:
trueif the text no longer can't be parsed by the current expression;falseif more can be parsed
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursortolerant- Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression's string representationactual- Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers
-
toParsedTextUntilAs
public java.lang.String toParsedTextUntilAs()
Creates a string representation of this expression up and excluding the AS identifier.- Returns:
- The string representation of a section of this expression
-
-