Class InExpressionStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject<StateObject>
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.InExpressionStateObject
-
- All Implemented Interfaces:
ListHolderStateObject<StateObject>
,StateObject
public class InExpressionStateObject extends AbstractListHolderStateObject<StateObject>
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 anIN
orNOT IN
expression isNULL
or unknown, the value of the expression is unknown.JPA 1.0:
BNF:JPA 2.0in_expression ::= state_field_path_expression [NOT] IN(in_item {, in_item}* | subquery)
BNF:in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }
- Since:
- 2.4
- Version:
- 2.4
- Author:
- Pascal Filion
- See Also:
InExpression
-
-
Field Summary
Fields Modifier and Type Field Description static String
ITEMS_LIST
Notifies the list of items has changed.static String
NOT_PROPERTY
Notifies the visibility of theNOT
identifier has changed.static String
STATE_OBJECT_PROPERTY
Notifies theStateObject
representing the state field path expression or the input parameter has changed.
-
Constructor Summary
Constructors Constructor Description InExpressionStateObject(StateObject parent)
Creates a newInExpressionStateObject
.InExpressionStateObject(StateObject parent, boolean not, String path, String parameter)
Creates a newInExpressionStateObject
.InExpressionStateObject(StateObject parent, boolean not, String path, List<String> items)
Creates a newInExpressionStateObject
.InExpressionStateObject(StateObject parent, String path, List<String> items)
Creates a newInExpressionStateObject
.InExpressionStateObject(StateObject parent, StateObject stateObject, boolean not, List<? extends StateObject> items)
Creates a newInExpressionStateObject
.InExpressionStateObject(StateObject parent, StateObject stateFieldPath, List<? extends StateObject> items)
Creates a newInExpressionStateObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.InExpressionStateObject
addNot()
Makes sure theNOT
identifier is specified.InExpression
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.StateObject
getStateObject()
Returnsboolean
hasNot()
Determines whether theNOT
identifier is used or not.boolean
hasStateObject()
Determines whetherboolean
isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e.boolean
isSingleInputParameter()
Determines whether what was parsed after theIN
identifier is a single input parameter.void
parse(String jpqlFragment)
Parses the given JPQL fragment, which represents either a single or many items, the fragment will be parsed and converted intoStateObject
.void
removeNot()
Makes sure theNOT
identifier is not specified.void
setExpression(InExpression 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
setSingleInputParameter(boolean singleInputParameter)
Sets whether what was parsed after theIN
identifier is a single input parameter.void
setStateObject(StateObject stateObject)
Setsvoid
toggleNot()
Changes the visibility state of theNOT
identifier.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject
addItem, addItems, addListChangeListener, canMoveDown, canMoveUp, getItem, hasItems, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener
-
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
-
Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText
-
-
-
-
Field Detail
-
ITEMS_LIST
public static String ITEMS_LIST
Notifies the list of items has changed.
-
NOT_PROPERTY
public static final String NOT_PROPERTY
Notifies the visibility of theNOT
identifier has changed.- See Also:
- Constant Field Values
-
STATE_OBJECT_PROPERTY
public static final String STATE_OBJECT_PROPERTY
Notifies theStateObject
representing the state field path expression or the input parameter has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
InExpressionStateObject
public InExpressionStateObject(StateObject parent)
Creates a newInExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
NullPointerException
- The given parent cannot benull
-
InExpressionStateObject
public InExpressionStateObject(StateObject parent, boolean not, String path, List<String> items)
Creates a newInExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
path
-not
- Determines whether theNOT
identifier is part of the expression or notitems
- The list of JPQL fragments that will be parsed and converted intoStateObject
- Throws:
NullPointerException
- The given parent cannot benull
-
InExpressionStateObject
public InExpressionStateObject(StateObject parent, boolean not, String path, String parameter)
Creates a newInExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
path
-not
- Determines whether theNOT
identifier is part of the expression or notparameter
- The- Throws:
NullPointerException
- The given parent cannot benull
-
InExpressionStateObject
public InExpressionStateObject(StateObject parent, StateObject stateObject, boolean not, List<? extends StateObject> items)
Creates a newInExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stateObject
-not
- Determines whether theNOT
identifier is part of the expression or notitems
-- Throws:
NullPointerException
- The given parent cannot benull
-
InExpressionStateObject
public InExpressionStateObject(StateObject parent, StateObject stateFieldPath, List<? extends StateObject> items)
Creates a newInExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stateFieldPath
-items
-- Throws:
NullPointerException
- The given parent cannot benull
-
InExpressionStateObject
public InExpressionStateObject(StateObject parent, String path, List<String> items)
Creates a newInExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
path
-items
- The list of JPQL fragments that will be parsed and converted intoStateObject
- 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 InExpressionStateObject addNot()
Makes sure theNOT
identifier is specified.- Returns:
- This object
-
getExpression
public InExpression 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)
-
getStateObject
public StateObject getStateObject()
Returns- Returns:
-
hasNot
public boolean hasNot()
Determines whether theNOT
identifier is used or not.- Returns:
true
if theNOT
identifier is part of the expression;false
otherwise
-
hasStateObject
public boolean hasStateObject()
Determines whether- Returns:
-
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
-
isSingleInputParameter
public boolean isSingleInputParameter()
Determines whether what was parsed after theIN
identifier is a single input parameter.- Returns:
true
if the only item is an input parameter;false
otherwise
-
parse
public void parse(String jpqlFragment)
Parses the given JPQL fragment, which represents either a single or many items, the fragment will be parsed and converted intoStateObject
.- Parameters:
jpqlFragment
- The portion of the query to parse
-
removeNot
public void removeNot()
Makes sure theNOT
identifier is not specified.
-
setExpression
public void setExpression(InExpression 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 anIN
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
-
setSingleInputParameter
public void setSingleInputParameter(boolean singleInputParameter)
Sets whether what was parsed after theIN
identifier is a single input parameter.- Parameters:
singleInputParameter
-true
if the only item is an input parameter;false
otherwise
-
setStateObject
public void setStateObject(StateObject stateObject)
Sets- Parameters:
stateObject
-
-
toggleNot
public void toggleNot()
Changes the visibility state of theNOT
identifier.
-
-