CollectionMemberExpression (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

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

Since:

2.3

Version:

2.5

Author:

Pascal Filion

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 and Description
`CollectionMemberExpression(AbstractExpression parent, AbstractExpression expression)` Creates a new `CollectionMemberExpression`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(ExpressionVisitor visitor)` Visits this `Expression` by the given `visitor`.
`void`	`acceptChildren(ExpressionVisitor visitor)` Visits the children of this `Expression`.
`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.

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CollectionMemberExpression
```
public CollectionMemberExpression(AbstractExpression parent,
                                  AbstractExpression expression)
```
    Creates a new CollectionMemberExpression.
    
    Parameters:
    
    parent - The parent of this expression
    
    expression - The entity expression that was parsed before parsing this one
- Method Detail
  - accept
```
public void accept(ExpressionVisitor visitor)
```
    Visits this Expression by the given visitor.
    
    Parameters:
    
    visitor - The ExpressionVisitor to visit this object
  - acceptChildren
```
public void acceptChildren(ExpressionVisitor visitor)
```
    Visits the children of this 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.
    
    Parameters:
    
    visitor - The visitor to visit the children of this object.
  - findQueryBNF
```
public JPQLQueryBNF findQueryBNF(Expression expression)
```
    Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
    
    Specified by:
    
    findQueryBNF in interface Expression
    
    Overrides:
    
    findQueryBNF in class AbstractExpression
    
    Parameters:
    
    expression - The Expression that is a descendant of this one
    
    Returns:
    
    The JPQLQueryBNF that 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 the Expression representing the collection-valued path expression.
    
    Returns:
    
    The expression that was parsed representing the collection valued path expression
  - getEntityExpression
```
public Expression getEntityExpression()
```
    Returns the Expression representing 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 this Expression.
    
    Returns:
    
    The JPQLQueryBNF, which represents the grammar of this Expression
  - hasCollectionValuedPathExpression
```
public boolean hasCollectionValuedPathExpression()
```
    Determines whether the collection-valued path expression was parsed.
    
    Returns:
    
    true if the collection-valued path expression was parsed; false otherwise
  - hasEntityExpression
```
public boolean hasEntityExpression()
```
    Determines whether the entity expression was parsed.
    
    Returns:
    
    true if the entity expression was parsed; false otherwise
  - hasNot
```
public boolean hasNot()
```
    Determines whether the identifier NOT was parsed.
    
    Returns:
    
    true if the identifier NOT was parsed; false otherwise
  - hasOf
```
public boolean hasOf()
```
    Determines whether the identifier OF was parsed.
    
    Returns:
    
    true if the identifier OF was parsed; false otherwise
  - hasSpaceAfterMember
```
public boolean hasSpaceAfterMember()
```
    Determines whether a whitespace was found after MEMBER.
    
    Returns:
    
    true if there was a whitespace after MEMBER; false otherwise
  - hasSpaceAfterOf
```
public boolean hasSpaceAfterOf()
```
    Determines whether a whitespace was found after OF.
    
    Returns:
    
    true if there was a whitespace after OF; false otherwise

Class CollectionMemberExpression

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

Methods inherited from class java.lang.Object

Constructor Detail

CollectionMemberExpression

Method Detail

accept

acceptChildren

findQueryBNF

getActualMemberIdentifier

getActualNotIdentifier

getActualOfIdentifier

getCollectionValuedPathExpression

getEntityExpression

getIdentifier

getQueryBNF

hasCollectionValuedPathExpression

hasEntityExpression

hasNot

hasOf

hasSpaceAfterMember

hasSpaceAfterOf