Class CollectionMemberExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.CollectionMemberExpression
-
- All Implemented Interfaces:
Expression
public final class CollectionMemberExpression extends AbstractExpression
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.BNF:collection_member_expression ::= entity_or_value_expression [NOT] MEMBER [OF] collection_valued_path_expression- 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 CollectionMemberExpression(AbstractExpression parent, AbstractExpression expression)Creates a newCollectionMemberExpression.
-
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.StringgetActualMemberIdentifier()Returns the actual MEMBER identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualNotIdentifier()Returns the actual NOT identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualOfIdentifier()Returns the actual OF identifier found in the string representation of the JPQL query, which has the actual case that was used.ExpressiongetCollectionValuedPathExpression()Returns theExpressionrepresenting the collection-valued path expression.ExpressiongetEntityExpression()Returns theExpressionrepresenting the entity expression.java.lang.StringgetIdentifier()Returns the identifier for this expression that may include NOT and OF if it was parsed.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.booleanhasCollectionValuedPathExpression()Determines whether the collection-valued path expression was parsed.booleanhasEntityExpression()Determines whether the entity expression was parsed.booleanhasNot()Determines whether the identifier NOT was parsed.booleanhasOf()Determines whether the identifier OF was parsed.booleanhasSpaceAfterMember()Determines whether a whitespace was found after MEMBER.booleanhasSpaceAfterOf()Determines whether a whitespace was found after OF.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.-
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, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
CollectionMemberExpression
public CollectionMemberExpression(AbstractExpression parent, AbstractExpression expression)
Creates a newCollectionMemberExpression.- Parameters:
parent- The parent of this expressionexpression- The entity expression that was parsed before parsing this one
-
-
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
-
getActualMemberIdentifier
public 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.- Returns:
- The MEMBER identifier that was actually parsed
-
getActualNotIdentifier
public 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.- Returns:
- The NOT identifier that was actually parsed, or an empty string if it was not parsed
-
getActualOfIdentifier
public 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.- Returns:
- The OF identifier that was actually parsed, or an empty string if it was not parsed
-
getCollectionValuedPathExpression
public Expression getCollectionValuedPathExpression()
Returns theExpressionrepresenting the collection-valued path expression.- Returns:
- The expression that was parsed representing the collection valued path expression
-
getEntityExpression
public Expression getEntityExpression()
Returns theExpressionrepresenting the entity expression.- Returns:
- The expression that was parsed representing the entity expression
-
getIdentifier
public java.lang.String getIdentifier()
Returns the identifier for this expression that may include NOT and OF if it was parsed.- Returns:
- Either MEMBER, NOT MEMBER, NOT MEMBER OF or MEMBER OF
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
hasCollectionValuedPathExpression
public boolean hasCollectionValuedPathExpression()
Determines whether the collection-valued path expression was parsed.- Returns:
trueif the collection-valued path expression was parsed;falseotherwise
-
hasEntityExpression
public boolean hasEntityExpression()
Determines whether the entity expression was parsed.- Returns:
trueif the entity expression was parsed;falseotherwise
-
hasNot
public boolean hasNot()
Determines whether the identifier NOT was parsed.- Returns:
trueif the identifier NOT was parsed;falseotherwise
-
hasOf
public boolean hasOf()
Determines whether the identifier OF was parsed.- Returns:
trueif the identifier OF was parsed;falseotherwise
-
hasSpaceAfterMember
public boolean hasSpaceAfterMember()
Determines whether a whitespace was found after MEMBER.- Returns:
trueif there was a whitespace after MEMBER;falseotherwise
-
hasSpaceAfterOf
public boolean hasSpaceAfterOf()
Determines whether a whitespace was found after OF.- Returns:
trueif there was a whitespace after OF;falseotherwise
-
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
-
-