|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.CollectionMemberDeclaration
public final class CollectionMemberDeclaration
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.
collection_member_declaration ::= IN(collection_valued_path_expression) [AS] identification_variable
or
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
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 |
Constructor Summary | |
---|---|
CollectionMemberDeclaration(AbstractExpression parent)
Creates a new CollectionMemberDeclaration . |
Method Summary | |
---|---|
void |
accept(ExpressionVisitor visitor)
Visits this Expression by the given visitor . |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this Expression . |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression . |
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. |
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. |
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. |
boolean |
isDerived()
Determines whether this collection member declaration is used as a derived collection-valued path expression. |
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. |
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given WordParser . |
protected void |
toParsedText(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this Expression , including its children,
if it has any. |
java.lang.String |
toParsedTextUntilAs()
Creates a string representation of this expression up and excluding the AS identifier. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CollectionMemberDeclaration(AbstractExpression parent)
CollectionMemberDeclaration
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.
visitor
- The ExpressionVisitor
to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
Expression
. This method can be used to optimize traversing
the children since a new list is not created every time Expression.children()
is called.
This does not traverse the Expression
sub-hierarchy, use a subclass of
AbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.
visitor
- The visitor
to visit the children of this object.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression
to the given collection.
addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression
to the given list.
addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this AbstractExpression
public JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF
that represents the fragment of this Expression
that was used when parsing the given Expression
.
findQueryBNF
in interface Expression
findQueryBNF
in class AbstractExpression
expression
- The Expression
that is a descendant of this one
JPQLQueryBNF
that was used to parse the given expressionpublic java.lang.String getActualAsIdentifier()
public java.lang.String getActualInIdentifier()
public Expression getCollectionValuedPathExpression()
Expression
representing the collection member, which is declared by an
identification variable.
public Expression getIdentificationVariable()
Expression
representing the identification variable, which maps the
collection-valued path expression.
public JPQLQueryBNF getQueryBNF()
Expression
.
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasAs()
true
if the identifier AS was parsed; false
otherwisepublic boolean hasCollectionValuedPathExpression()
true
if the query has the collection-valued path expression;
false
otherwisepublic boolean hasIdentificationVariable()
true
if the query has the identification variable; false
otherwisepublic boolean hasLeftParenthesis()
true
if the open parenthesis was present in the string version of the
query; false
otherwisepublic boolean hasRightParenthesis()
true
if the close parenthesis was present in the string version of the
query; false
otherwisepublic boolean hasSpaceAfterAs()
true
if there was a whitespace after AS; false
otherwisepublic boolean hasSpaceAfterIn()
true
if there was a whitespace after IN; false
otherwisepublic boolean hasSpaceAfterRightParenthesis()
true
if there was a whitespace after the right parenthesis;
false
otherwisepublic boolean isDerived()
true
if this collection member declaration is used as this form:
"IN collection_valued_path_expression
" in a subquery; false
if it's used as this form: IN(collection_valued_path_expression)
[AS] identification_variable
" in a top-level or subquery queriesprotected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
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
- The Expression
that has already been parsed
true
if the text no longer can't be parsed by the current expression;
false
if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser
.
parse
in class AbstractExpression
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 queriesprotected void toParsedText(java.lang.StringBuilder writer, boolean actual)
Expression
, including its children,
if it has any.
toParsedText
in class AbstractExpression
writer
- The buffer used to append this Expression
'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 identifierspublic java.lang.String toParsedTextUntilAs()
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |