|
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.CollectionMemberExpression
public final class CollectionMemberExpression
This expression tests whether the designated value is a member of the collection specified by the collection-valued path expression. If the collection-valued path expression designates an empty collection, the value of the MEMBER OF expression is FALSE and the value of the NOT MEMBER OF expression is TRUE. Otherwise, if the value of the collection-valued path expression or single-valued association-field path expression in the collection member expression is NULL or unknown, the value of the collection member expression is unknown.
collection_member_expression ::= entity_or_value_expression [NOT] MEMBER [OF] collection_valued_path_expression
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 | |
---|---|
CollectionMemberExpression(AbstractExpression parent,
AbstractExpression expression)
Creates a new CollectionMemberExpression . |
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 |
getActualMemberIdentifier()
Returns the actual MEMBER identifier found in the string representation of the JPQL query, which has the actual case that was used. |
java.lang.String |
getActualNotIdentifier()
Returns the actual NOT identifier found in the string representation of the JPQL query, which has the actual case that was used. |
java.lang.String |
getActualOfIdentifier()
Returns the actual OF 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-valued path expression. |
Expression |
getEntityExpression()
Returns the Expression representing the entity expression. |
java.lang.String |
getIdentifier()
Returns the identifier for this expression that may include NOT and OF if it was parsed. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this Expression . |
boolean |
hasCollectionValuedPathExpression()
Determines whether the collection-valued path expression was parsed. |
boolean |
hasEntityExpression()
Determines whether the entity expression was parsed. |
boolean |
hasNot()
Determines whether the identifier NOT was parsed. |
boolean |
hasOf()
Determines whether the identifier OF was parsed. |
boolean |
hasSpaceAfterMember()
Determines whether a whitespace was found after MEMBER. |
boolean |
hasSpaceAfterOf()
Determines whether a whitespace was found after OF. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CollectionMemberExpression(AbstractExpression parent, AbstractExpression expression)
CollectionMemberExpression
.
parent
- The parent of this expressionexpression
- The entity expression that was parsed before parsing this oneMethod 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 getActualMemberIdentifier()
public java.lang.String getActualNotIdentifier()
public java.lang.String getActualOfIdentifier()
public Expression getCollectionValuedPathExpression()
Expression
representing the collection-valued path expression.
public Expression getEntityExpression()
Expression
representing the entity expression.
public java.lang.String getIdentifier()
public JPQLQueryBNF getQueryBNF()
Expression
.
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasCollectionValuedPathExpression()
true
if the collection-valued path expression was parsed;
false
otherwisepublic boolean hasEntityExpression()
true
if the entity expression was parsed; false
otherwisepublic boolean hasNot()
true
if the identifier NOT was parsed; false
otherwisepublic boolean hasOf()
true
if the identifier OF was parsed; false
otherwisepublic boolean hasSpaceAfterMember()
true
if there was a whitespace after MEMBER; false
otherwisepublic boolean hasSpaceAfterOf()
true
if there was a whitespace after OF; false
otherwiseprotected 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 identifiers
|
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 |