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
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
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionCreates 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
Modifier and TypeMethodDescriptionvoid
accept
(StateObjectVisitor visitor) Visits thisStateObject
by the givenvisitor
.protected void
addChildren
(List<StateObject> children) Adds the children of thisStateObject
to the given list.addNot()
Makes sure theNOT
identifier is specified.addOf()
Makes sure theOF
identifier is specified.Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.boolean
boolean
hasNot()
Determines whether theNOT
identifier is used or not.boolean
hasOf()
protected void
Initializes this state object.boolean
isEquivalent
(StateObject stateObject) Determines whether the givenStateObject
is equivalent to this one, i.e.void
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
Changes the visibility state of theNOT
identifier.void
toggleOf()
Changes the visibility state of theOF
identifier.protected void
toTextInternal
(Appendable writer) Prints out a string representation of thisStateObject
, which should not be used to define atrue
string representation of a JPQL query but should be used for debugging purposes.Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText
-
Field Details
-
ENTITY_STATE_OBJECT_PROPERTY
Notifies the entity state object property has changed.- See Also:
-
NOT_PROPERTY
Notifies the visibility of theNOT
identifier has changed.- See Also:
-
OF_PROPERTY
Notifies the visibility of theOF
identifier has changed.- See Also:
-
-
Constructor Details
-
CollectionMemberExpressionStateObject
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
not
- Determines whether theNOT
identifier is part of the expression or not- 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
- Throws:
NullPointerException
- The given parent cannot benull
-
-
Method Details
-
accept
Description copied from interface:StateObject
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
addChildren
Description copied from class:AbstractStateObject
Adds the children of thisStateObject
to the given list.- Overrides:
addChildren
in classAbstractStateObject
- Parameters:
children
- The list used to store the children
-
addNot
Makes sure theNOT
identifier is specified.- Returns:
- This object
-
addOf
Makes sure theOF
identifier is specified.- Returns:
- This object
-
getCollectionValuedPath
-
getEntityStateObject
-
getExpression
Description copied from interface:StateObject
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() -
initialize
protected void initialize()Description copied from class:AbstractStateObject
Initializes this state object.- Overrides:
initialize
in classAbstractStateObject
-
isEquivalent
Description copied from interface: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
Sets -
setExpression
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. -
toTextInternal
Description copied from class:AbstractStateObject
Prints out a string representation of thisStateObject
, which should not be used to define atrue
string representation of a JPQL query but should be used for debugging purposes.- Specified by:
toTextInternal
in classAbstractStateObject
- Parameters:
writer
- The writer used to print out the string representation- Throws:
IOException
- This should never happens, it is only required becauseAppendable
is used instead of any concrete class
-