|
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.AbstractListHolderStateObject<StateObject>
org.eclipse.persistence.jpa.jpql.model.query.InExpressionStateObject
public class InExpressionStateObject
The state field path expression must have a string, numeric, or enum value. The literal and/or input parameter values must be like the same abstract schema type of the state field path expression in type.
The results of the subquery must be like the same abstract schema type of the state field path expression in type.
There must be at least one element in the comma separated list that defines the set of values for
the IN
expression. If the value of a state field path expression in an
IN
or NOT IN
expression is NULL
or
unknown, the value of the expression is unknown.
JPA 1.0:
in_expression ::= state_field_path_expression [NOT] IN(in_item {, in_item}* | subquery)
JPA 2.0
in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }
InExpression
Field Summary | |
---|---|
static java.lang.String |
ITEMS_LIST
Notifies the list of items has changed. |
static java.lang.String |
NOT_PROPERTY
Notifies the visibility of the NOT identifier has changed. |
static java.lang.String |
STATE_OBJECT_PROPERTY
Notifies the StateObject representing the state field path expression or the input
parameter has changed. |
Constructor Summary | |
---|---|
InExpressionStateObject(StateObject parent)
Creates a new InExpressionStateObject . |
|
InExpressionStateObject(StateObject parent,
boolean not,
java.lang.String path,
java.util.List<java.lang.String> items)
Creates a new InExpressionStateObject . |
|
InExpressionStateObject(StateObject parent,
boolean not,
java.lang.String path,
java.lang.String parameter)
Creates a new InExpressionStateObject . |
|
InExpressionStateObject(StateObject parent,
StateObject stateObject,
boolean not,
java.util.List<? extends StateObject> items)
Creates a new InExpressionStateObject . |
|
InExpressionStateObject(StateObject parent,
StateObject stateFieldPath,
java.util.List<? extends StateObject> items)
Creates a new InExpressionStateObject . |
|
InExpressionStateObject(StateObject parent,
java.lang.String path,
java.util.List<java.lang.String> items)
Creates a new InExpressionStateObject . |
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. |
InExpressionStateObject |
addNot()
Makes sure the NOT identifier is specified. |
InExpression |
getExpression()
Returns the actual parsed object if this StateObject representation of the JPQL query
was created by parsing an existing JPQL query. |
StateObject |
getStateObject()
Returns |
boolean |
hasNot()
Determines whether the NOT identifier is used or not. |
boolean |
hasStateObject()
Determines whether |
boolean |
isEquivalent(StateObject stateObject)
Determines whether the given StateObject is equivalent to this one, i.e. the
information of both StateObject is the same. |
boolean |
isSingleInputParameter()
Determines whether what was parsed after the IN identifier is a single input
parameter. |
protected java.lang.String |
listName()
Returns the name that is uniquely identifying the list. |
void |
parse(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which represents either a single or many items, the fragment will be parsed and converted into StateObject . |
void |
removeNot()
Makes sure the NOT identifier is not specified. |
void |
setExpression(InExpression 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 |
setSingleInputParameter(boolean singleInputParameter)
Sets whether what was parsed after the IN identifier is a single input parameter. |
void |
setStateObject(StateObject stateObject)
Sets |
void |
toggleNot()
Changes the visibility state of the NOT 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.AbstractListHolderStateObject |
---|
addItem, addItems, addListChangeListener, areChildrenEquivalent, canMoveDown, canMoveUp, getItem, hasItems, initialize, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener, toStringItems |
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 |
Methods inherited from interface org.eclipse.persistence.jpa.jpql.model.query.StateObject |
---|
addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText |
Field Detail |
---|
public static java.lang.String ITEMS_LIST
public static final java.lang.String NOT_PROPERTY
NOT
identifier has changed.
public static final java.lang.String STATE_OBJECT_PROPERTY
StateObject
representing the state field path expression or the input
parameter has changed.
Constructor Detail |
---|
public InExpressionStateObject(StateObject parent)
InExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
java.lang.NullPointerException
- The given parent cannot be null
public InExpressionStateObject(StateObject parent, boolean not, java.lang.String path, java.util.List<java.lang.String> items)
InExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
stateFieldPath
- not
- Determines whether the NOT
identifier is part of the expression
or notinItems
- The list of JPQL fragments that will be parsed and converted into StateObject
java.lang.NullPointerException
- The given parent cannot be null
public InExpressionStateObject(StateObject parent, boolean not, java.lang.String path, java.lang.String parameter)
InExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
path
- not
- Determines whether the NOT
identifier is part of the expression
or notparameter
- The
java.lang.NullPointerException
- The given parent cannot be null
public InExpressionStateObject(StateObject parent, StateObject stateObject, boolean not, java.util.List<? extends StateObject> items)
InExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
stateFieldPath
- not
- Determines whether the NOT
identifier is part of the expression
or notitems
-
java.lang.NullPointerException
- The given parent cannot be null
public InExpressionStateObject(StateObject parent, StateObject stateFieldPath, java.util.List<? extends StateObject> items)
InExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
stateFieldPath
- items
-
java.lang.NullPointerException
- The given parent cannot be null
public InExpressionStateObject(StateObject parent, java.lang.String path, java.util.List<java.lang.String> items)
InExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
path
- inItems
- The list of JPQL fragments that will be parsed and converted into StateObject
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 AbstractListHolderStateObject<StateObject>
children
- The list used to store the childrenpublic InExpressionStateObject addNot()
NOT
identifier is specified.
public InExpression 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 StateObject getStateObject()
public boolean hasNot()
NOT
identifier is used or not.
true
if the NOT
identifier is part of the expression;
false
otherwisepublic boolean hasStateObject()
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 boolean isSingleInputParameter()
IN
identifier is a single input
parameter.
true
if the only item is an input parameter; false
otherwiseprotected java.lang.String listName()
listName
in class AbstractListHolderStateObject<StateObject>
public void parse(java.lang.String jpqlFragment)
StateObject
.
jpqlFragment
- The portion of the query to parsepublic void removeNot()
NOT
identifier is not specified.
public void setExpression(InExpression 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 an IN
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 setSingleInputParameter(boolean singleInputParameter)
IN
identifier is a single input parameter.
singleInputParameter
- true
if the only item is an input parameter;
false
otherwisepublic void setStateObject(StateObject stateObject)
stateObject
- public void toggleNot()
NOT
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 |