|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
org.eclipse.persistence.jpa.jpql.model.query.CollectionMemberExpressionStateObject
public class CollectionMemberExpressionStateObject
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.
collection_member_expression ::= entity_or_value_expression [NOT] MEMBER [OF] collection_valued_path_expression
CollectionMemberExpression
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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.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 |
---|
public static final java.lang.String ENTITY_STATE_OBJECT_PROPERTY
public static final java.lang.String NOT_PROPERTY
NOT
identifier has changed.
public static final java.lang.String OF_PROPERTY
OF
identifier has changed.
Constructor Detail |
---|
public CollectionMemberExpressionStateObject(StateObject parent)
CollectionMemberExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
java.lang.NullPointerException
- The given parent cannot be null
public CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, boolean not, boolean of, java.lang.String collectionValuedPath)
CollectionMemberExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
entityStateObject
- not
- Determines whether the NOT
identifier is part of the expression
or notof
- collectionValuedPath
-
java.lang.NullPointerException
- The given parent cannot be null
public CollectionMemberExpressionStateObject(StateObject parent, StateObject entityStateObject, java.lang.String collectionValuedPath)
CollectionMemberExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
entityStateObject
- collectionValuedPath
-
java.lang.NullPointerException
- The given parent cannot be null
Method Detail |
---|
public void accept(StateObjectVisitor visitor)
StateObject
by the given visitor
.
visitor
- The visitor
to visit this objectprotected void addChildren(java.util.List<StateObject> children)
StateObject
to the given list.
addChildren
in class AbstractStateObject
children
- The list used to store the childrenpublic CollectionMemberExpressionStateObject addNot()
NOT
identifier is specified.
public CollectionMemberExpressionStateObject addOf()
OF
identifier is specified.
public CollectionValuedPathExpressionStateObject getCollectionValuedPath()
public StateObject getEntityStateObject()
public CollectionMemberExpression getExpression()
StateObject
representation of the JPQL query
was created by parsing an existing JPQL query.
getExpression
in interface StateObject
getExpression
in class AbstractStateObject
StateObject
or null
when the JPQL query is manually created (i.e. not from a string)public boolean hasEntityStateObject()
public boolean hasNot()
NOT
identifier is used or not.
true
if the NOT
identifier is part of the expression;
false
otherwisepublic boolean hasOf()
protected void initialize()
initialize
in class AbstractStateObject
public boolean isEquivalent(StateObject stateObject)
StateObject
is equivalent to this one, i.e. the
information of both StateObject
is the same.
isEquivalent
in interface StateObject
isEquivalent
in class AbstractStateObject
stateObject
- The StateObject
to compare its content to this one
true
if both object are equivalent; false
otherwisepublic void removeNot()
NOT
identifier is not specified.
public void removeOf()
OF
identifier is not specified.
public void setEntityStateObject(StateObject entityStateObject)
entityStateObject
- public void setExpression(CollectionMemberExpression expression)
parsed object
object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
StateObjects
.
expression
- The parsed object
representing a
collection member expressionpublic void setNot(boolean not)
NOT
identifier should be part of the expression or not.
not
- true
if the NOT
identifier should be part of the
expression; false
otherwisepublic void setOf(boolean of)
public void toggleNot()
NOT
identifier.
public void toggleOf()
OF
identifier.
protected void toTextInternal(java.lang.Appendable writer) throws java.io.IOException
StateObject
, which should not be used to
define a true
string representation of a JPQL query but should be used for
debugging purposes.
toTextInternal
in class AbstractStateObject
writer
- The writer used to print out the string representation
java.io.IOException
- This should never happens, it is only required because Appendable
is used instead of any concrete class
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |