|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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 | |
---|---|
private AbstractExpression |
collectionValuedPathExpression The Expression representing the collection member, which is declared by an identification variable. |
private boolean |
hasAs Determines whether the identifier AS was parsed. |
private boolean |
hasLeftParenthesis Flag used to determine if the closing parenthesis is present in the query. |
private boolean |
hasRightParenthesis Flag used to determine if the opening parenthesis is present in the query. |
private boolean |
hasSpaceAfterAs Determines whether a whitespace was parsed after AS. |
private boolean |
hasSpaceAfterIn Determines whether a whitespace was parsed after IN. |
private boolean |
hasSpaceAfterRightParenthesis Determines whether a whitespace was parsed after the right parenthesis. |
private AbstractExpression |
identificationVariable The Expression representing the identification variable, which maps the collection- valued path expression. |
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 |
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 . |
(package private) void |
addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection. |
(package private) void |
addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing 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. |
(package private) 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. |
(package private) void |
parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser . |
(package private) void |
toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression . |
(package private) java.lang.String |
toParsedTextUntilAs() Creates a string representation of this expression up and excluding the AS identifier. |
Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression |
---|
buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private AbstractExpression collectionValuedPathExpression
Expression
representing the collection member, which is declared by an identification variable.private boolean hasAs
private boolean hasLeftParenthesis
private boolean hasRightParenthesis
private boolean hasSpaceAfterAs
private boolean hasSpaceAfterIn
private boolean hasSpaceAfterRightParenthesis
private AbstractExpression identificationVariable
Expression
representing the identification variable, which maps the collection- valued path expression.Constructor Detail |
---|
CollectionMemberDeclaration(AbstractExpression parent)
CollectionMemberDeclaration
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The visitor
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()
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.
visitor
- The visitor
to visit the children of this object.void addChildrenTo(java.util.Collection<Expression> children)
Expression
to the given collection.addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenvoid addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this Expression
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
.getQueryBNF
in class AbstractExpression
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
otherwiseboolean 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 parsedtrue
if the text no longer can't be parsed by the current expression; false
if more can be parsedvoid 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 queriesvoid toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractExpression
writer
- The buffer used to append this Expression
's string representationincludeVirtual
- Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assistjava.lang.String toParsedTextUntilAs()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |