java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
- - org.eclipse.persistence.jpa.jpql.tools.model.query.CollectionMemberExpressionStateObject

All Implemented Interfaces:

StateObject
```
public class CollectionMemberExpressionStateObject
extends AbstractStateObject
```
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.4

Version:

2.4

Author:

Pascal Filion

See Also:

CollectionMemberExpression

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ENTITY_STATE_OBJECT_PROPERTY`	Notifies the entity state object property has changed.
`static String`	`NOT_PROPERTY`	Notifies the visibility of the `NOT` identifier has changed.
`static String`	`OF_PROPERTY`	Notifies the visibility of the `OF` identifier has changed.

Constructor Summary

Constructors
Constructor	Description
`CollectionMemberExpressionStateObject(StateObject parent)`	Creates a new `CollectionMemberExpressionStateObject`.
`CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, boolean not, boolean of, String collectionValuedPath)`	Creates a new `CollectionMemberExpressionStateObject`.
`CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, String collectionValuedPath)`	Creates a new `CollectionMemberExpressionStateObject`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(StateObjectVisitor visitor)`	Visits this `StateObject` by the given `visitor`.
`CollectionMemberExpressionStateObject`	`addNot()`	Makes sure the `NOT` identifier is specified.
`CollectionMemberExpressionStateObject`	`addOf()`	Makes sure the `OF` identifier is specified.
`CollectionValuedPathExpressionStateObject`	`getCollectionValuedPath()`
`StateObject`	`getEntityStateObject()`
`CollectionMemberExpression`	`getExpression()`	Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
`boolean`	`hasEntityStateObject()`
`boolean`	`hasNot()`	Determines whether the `NOT` identifier is used or not.
`boolean`	`hasOf()`
`boolean`	`isEquivalent(StateObject stateObject)`	Determines whether the given `StateObject` is equivalent to this one, i.e.
`void`	`removeNot()`	Makes sure the `NOT` identifier is not specified.
`void`	`removeOf()`	Makes sure the `OF` identifier is not specified.
`void`	`setEntityStateObject(StateObject entityStateObject)`	Sets
`void`	`setExpression(CollectionMemberExpression expression)`	Keeps a reference of the `parsed object` object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into `StateObjects`.
`void`	`setNot(boolean not)`	Sets whether the `NOT` identifier should be part of the expression or not.
`void`	`setOf(boolean of)`
`void`	`toggleNot()`	Changes the visibility state of the `NOT` identifier.
`void`	`toggleOf()`	Changes the visibility state of the `OF` identifier.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText

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

- Field Detail
  - ENTITY_STATE_OBJECT_PROPERTY
```
public static final String ENTITY_STATE_OBJECT_PROPERTY
```
    Notifies the entity state object property has changed.
    
    See Also:
    
    Constant Field Values
  - NOT_PROPERTY
```
public static final String NOT_PROPERTY
```
    Notifies the visibility of the NOT identifier has changed.
    
    See Also:
    
    Constant Field Values
  - OF_PROPERTY
```
public static final String OF_PROPERTY
```
    Notifies the visibility of the OF identifier has changed.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CollectionMemberExpressionStateObject
```
public CollectionMemberExpressionStateObject(StateObject parent)
```
    Creates a new CollectionMemberExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    Throws:
    
    NullPointerException - The given parent cannot be null
  - CollectionMemberExpressionStateObject
```
public CollectionMemberExpressionStateObject(StateObject parent,
                                             StateObject entityStateObject,
                                             boolean not,
                                             boolean of,
                                             String collectionValuedPath)
```
    Creates a new CollectionMemberExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    entityStateObject -
    
    not - Determines whether the NOT identifier is part of the expression or not
    
    of -
    
    collectionValuedPath -
    
    Throws:
    
    NullPointerException - The given parent cannot be null
  - CollectionMemberExpressionStateObject
```
public CollectionMemberExpressionStateObject(StateObject parent,
                                             StateObject entityStateObject,
                                             String collectionValuedPath)
```
    Creates a new CollectionMemberExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    entityStateObject -
    
    collectionValuedPath -
    
    Throws:
    
    NullPointerException - The given parent cannot be null
- Method Detail
  - accept
```
public void accept(StateObjectVisitor visitor)
```
    Visits this StateObject by the given visitor.
    
    Parameters:
    
    visitor - The visitor to visit this object
  - addNot
```
public CollectionMemberExpressionStateObject addNot()
```
    Makes sure the NOT identifier is specified.
    
    Returns:
    
    This object
  - addOf
```
public CollectionMemberExpressionStateObject addOf()
```
    Makes sure the OF identifier is specified.
    
    Returns:
    
    This object
  - getCollectionValuedPath
```
public CollectionValuedPathExpressionStateObject getCollectionValuedPath()
```
  - getEntityStateObject
```
public StateObject getEntityStateObject()
```
  - getExpression
```
public CollectionMemberExpression getExpression()
```
    Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
    
    Specified by:
    
    getExpression in interface StateObject
    
    Overrides:
    
    getExpression in class AbstractStateObject
    
    Returns:
    
    The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)
  - hasEntityStateObject
```
public boolean hasEntityStateObject()
```
  - hasNot
```
public boolean hasNot()
```
    Determines whether the NOT identifier is used or not.
    
    Returns:
    
    true if the NOT identifier is part of the expression; false otherwise
  - hasOf
```
public boolean hasOf()
```
  - isEquivalent
```
public boolean isEquivalent(StateObject stateObject)
```
    Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
    
    Specified by:
    
    isEquivalent in interface StateObject
    
    Overrides:
    
    isEquivalent in class AbstractStateObject
    
    Parameters:
    
    stateObject - The StateObject to compare its content to this one
    
    Returns:
    
    true if both object are equivalent; false otherwise
  - removeNot
```
public void removeNot()
```
    Makes sure the NOT identifier is not specified.
  - removeOf
```
public void removeOf()
```
    Makes sure the OF identifier is not specified.
  - setEntityStateObject
```
public void setEntityStateObject(StateObject entityStateObject)
```
    Sets
    
    Parameters:
    
    entityStateObject -
  - setExpression
```
public void setExpression(CollectionMemberExpression expression)
```
    Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.
    
    Parameters:
    
    expression - The parsed object representing a collection member expression
  - setNot
```
public void setNot(boolean not)
```
    Sets whether the NOT identifier should be part of the expression or not.
    
    Parameters:
    
    not - true if the NOT identifier should be part of the expression; false otherwise
  - setOf
```
public void setOf(boolean of)
```
  - toggleNot
```
public void toggleNot()
```
    Changes the visibility state of the NOT identifier.
  - toggleOf
```
public void toggleOf()
```
    Changes the visibility state of the OF identifier.

Class CollectionMemberExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

Methods inherited from class java.lang.Object

Field Detail

ENTITY_STATE_OBJECT_PROPERTY

NOT_PROPERTY

OF_PROPERTY

Constructor Detail

CollectionMemberExpressionStateObject

CollectionMemberExpressionStateObject

CollectionMemberExpressionStateObject

Method Detail

accept

addNot

addOf

getCollectionValuedPath

getEntityStateObject

getExpression

hasEntityStateObject

hasNot

hasOf

isEquivalent

removeNot

removeOf

setEntityStateObject

setExpression

setNot

setOf

toggleNot

toggleOf