|
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.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 | |
---|---|
private AbstractExpression |
collectionValuedPathExpression The Expression representing the collection-valued path expression. |
private AbstractExpression |
entityExpression The Expression representing the entity expression. |
private boolean |
hasNot Determines whether the identifier NOT was parsed. |
private boolean |
hasOf Determines whether the identifier OF was parsed. |
private boolean |
hasSpaceAfterMember Determines whether a whitespace was parsed after MEMBER. |
private boolean |
hasSpaceAfterOf Determines whether a whitespace was parsed after OF. |
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 | |
---|---|
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 . |
(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-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. |
(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 . |
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, isParsingComplete, 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-valued path expression.private AbstractExpression entityExpression
Expression
representing the entity expression.private boolean hasNot
private boolean hasOf
private boolean hasSpaceAfterMember
private boolean hasSpaceAfterOf
Constructor Detail |
---|
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 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-valued path expression.public Expression getEntityExpression()
Expression
representing the entity expression.public java.lang.String getIdentifier()
public JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
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
otherwisevoid 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 assist
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |