Package org.eclipse.persistence.jpa.jpql.tools.model.query

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 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.4

See Also:

CollectionMemberExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ENTITY_STATE_OBJECT_PROPERTY	Notifies the entity state object property has changed.
static java.lang.String	NOT_PROPERTY	Notifies the visibility of the NOT identifier has changed.
static java.lang.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, java.lang.String collectionValuedPath)	Creates a new CollectionMemberExpressionStateObject.
CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, java.lang.String collectionValuedPath)	Creates a new CollectionMemberExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
protected void	addChildren(java.util.List<StateObject> children)	Adds the children of this StateObject to the given list.
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()
protected void	initialize()	Initializes this state object.
boolean	isEquivalent(StateObject stateObject)	Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
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.
protected void	toTextInternal(java.lang.Appendable writer)	Prints out a string representation of this StateObject, which should not be used to define a true 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ENTITY_STATE_OBJECT_PROPERTY

public static final java.lang.String ENTITY_STATE_OBJECT_PROPERTY

Notifies the entity state object property has changed.

See Also:

Constant Field Values

NOT_PROPERTY

public static final java.lang.String NOT_PROPERTY

Notifies the visibility of the NOT identifier has changed.

See Also:

Constant Field Values

OF_PROPERTY

public static final java.lang.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:

java.lang.NullPointerException - The given parent cannot be null

CollectionMemberExpressionStateObject

public CollectionMemberExpressionStateObject(StateObject parent,
                                             StateObject entityStateObject,
                                             boolean not,
                                             boolean of,
                                             java.lang.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:

java.lang.NullPointerException - The given parent cannot be null

CollectionMemberExpressionStateObject

public CollectionMemberExpressionStateObject(StateObject parent,
                                             StateObject entityStateObject,
                                             java.lang.String collectionValuedPath)

Creates a new CollectionMemberExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

entityStateObject -

collectionValuedPath -

Throws:

java.lang.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

addChildren

protected void addChildren(java.util.List<StateObject> children)

Adds the children of this StateObject to the given list.

Overrides:

addChildren in class AbstractStateObject

Parameters:

children - The list used to store the children

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()

initialize

protected void initialize()

Initializes this state object.

Overrides:

initialize in class AbstractStateObject

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.

toTextInternal

protected void toTextInternal(java.lang.Appendable writer)
                       throws java.io.IOException

Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Specified by:

toTextInternal in class AbstractStateObject

Parameters:

writer - The writer used to print out the string representation

Throws:

java.io.IOException - This should never happens, it is only required because Appendable is used instead of any concrete class