Class CollectionMemberExpressionStateObject
- 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 theMEMBER OF
expression is FALSE and the value of theNOT 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 theNOT
identifier has changed.static String
OF_PROPERTY
Notifies the visibility of theOF
identifier has changed.
-
Constructor Summary
Constructors Constructor Description CollectionMemberExpressionStateObject(StateObject parent)
Creates a newCollectionMemberExpressionStateObject
.CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, boolean not, boolean of, String collectionValuedPath)
Creates a newCollectionMemberExpressionStateObject
.CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, String collectionValuedPath)
Creates a newCollectionMemberExpressionStateObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.CollectionMemberExpressionStateObject
addNot()
Makes sure theNOT
identifier is specified.CollectionMemberExpressionStateObject
addOf()
Makes sure theOF
identifier is specified.CollectionValuedPathExpressionStateObject
getCollectionValuedPath()
StateObject
getEntityStateObject()
CollectionMemberExpression
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.boolean
hasEntityStateObject()
boolean
hasNot()
Determines whether theNOT
identifier is used or not.boolean
hasOf()
boolean
isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e.void
removeNot()
Makes sure theNOT
identifier is not specified.void
removeOf()
Makes sure theOF
identifier is not specified.void
setEntityStateObject(StateObject entityStateObject)
Setsvoid
setExpression(CollectionMemberExpression expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.void
setNot(boolean not)
Sets whether theNOT
identifier should be part of the expression or not.void
setOf(boolean of)
void
toggleNot()
Changes the visibility state of theNOT
identifier.void
toggleOf()
Changes the visibility state of theOF
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
-
-
-
-
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 theNOT
identifier has changed.- See Also:
- Constant Field Values
-
OF_PROPERTY
public static final String OF_PROPERTY
Notifies the visibility of theOF
identifier has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CollectionMemberExpressionStateObject
public CollectionMemberExpressionStateObject(StateObject parent)
Creates a newCollectionMemberExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
NullPointerException
- The given parent cannot benull
-
CollectionMemberExpressionStateObject
public CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, boolean not, boolean of, String collectionValuedPath)
Creates a newCollectionMemberExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
entityStateObject
-not
- Determines whether theNOT
identifier is part of the expression or notof
-collectionValuedPath
-- Throws:
NullPointerException
- The given parent cannot benull
-
CollectionMemberExpressionStateObject
public CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, String collectionValuedPath)
Creates a newCollectionMemberExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
entityStateObject
-collectionValuedPath
-- Throws:
NullPointerException
- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
addNot
public CollectionMemberExpressionStateObject addNot()
Makes sure theNOT
identifier is specified.- Returns:
- This object
-
addOf
public CollectionMemberExpressionStateObject addOf()
Makes sure theOF
identifier is specified.- Returns:
- This object
-
getCollectionValuedPath
public CollectionValuedPathExpressionStateObject getCollectionValuedPath()
-
getEntityStateObject
public StateObject getEntityStateObject()
-
getExpression
public CollectionMemberExpression getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAbstractStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
hasEntityStateObject
public boolean hasEntityStateObject()
-
hasNot
public boolean hasNot()
Determines whether theNOT
identifier is used or not.- Returns:
true
if theNOT
identifier is part of the expression;false
otherwise
-
hasOf
public boolean hasOf()
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e. the information of bothStateObject
is the same.- Specified by:
isEquivalent
in interfaceStateObject
- Overrides:
isEquivalent
in classAbstractStateObject
- Parameters:
stateObject
- TheStateObject
to compare its content to this one- Returns:
true
if both object are equivalent;false
otherwise
-
removeNot
public void removeNot()
Makes sure theNOT
identifier is not specified.
-
removeOf
public void removeOf()
Makes sure theOF
identifier is not specified.
-
setEntityStateObject
public void setEntityStateObject(StateObject entityStateObject)
Sets- Parameters:
entityStateObject
-
-
setExpression
public void setExpression(CollectionMemberExpression expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.- Parameters:
expression
- Theparsed object
representing a collection member expression
-
setNot
public void setNot(boolean not)
Sets whether theNOT
identifier should be part of the expression or not.- Parameters:
not
-true
if theNOT
identifier should be part of the expression;false
otherwise
-
setOf
public void setOf(boolean of)
-
toggleNot
public void toggleNot()
Changes the visibility state of theNOT
identifier.
-
toggleOf
public void toggleOf()
Changes the visibility state of theOF
identifier.
-
-