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

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 an IN or NOT IN expression is NULL or unknown, the value of the expression is unknown.

JPA 1.0:

BNF: in_expression ::= state_field_path_expression [NOT] IN(in_item {, in_item}* | subquery)

JPA 2.0

BNF: in_expression ::= {state_field_path_expression | type_discriminator} [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }

Version:

2.4

See Also:

InExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and 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.
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.tools.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.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

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

Notifies the list of items has changed.

NOT_PROPERTY

public static final java.lang.String NOT_PROPERTY

Notifies the visibility of the NOT identifier has changed.

See Also:

Constant Field Values

STATE_OBJECT_PROPERTY

public static final java.lang.String STATE_OBJECT_PROPERTY

Notifies the StateObject 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 new InExpressionStateObject.

Parameters:

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

Throws:

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

InExpressionStateObject

public InExpressionStateObject(StateObject parent,
                       boolean not,
                       java.lang.String path,
                       java.util.List<java.lang.String> items)

Creates a new InExpressionStateObject.

Parameters:

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

stateFieldPath -

not - Determines whether the NOT identifier is part of the expression or not

inItems - The list of JPQL fragments that will be parsed and converted into StateObject

Throws:

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

InExpressionStateObject

public InExpressionStateObject(StateObject parent,
                       boolean not,
                       java.lang.String path,
                       java.lang.String parameter)

Creates a new InExpressionStateObject.

Parameters:

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

path -

not - Determines whether the NOT identifier is part of the expression or not

parameter - The

Throws:

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

InExpressionStateObject

public InExpressionStateObject(StateObject parent,
                       StateObject stateObject,
                       boolean not,
                       java.util.List<? extends StateObject> items)

Creates a new InExpressionStateObject.

Parameters:

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

stateFieldPath -

not - Determines whether the NOT identifier is part of the expression or not

items -

Throws:

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

InExpressionStateObject

public InExpressionStateObject(StateObject parent,
                       StateObject stateFieldPath,
                       java.util.List<? extends StateObject> items)

Creates a new InExpressionStateObject.

Parameters:

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

stateFieldPath -

items -

Throws:

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

InExpressionStateObject

public InExpressionStateObject(StateObject parent,
                       java.lang.String path,
                       java.util.List<java.lang.String> items)

Creates a new InExpressionStateObject.

Parameters:

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

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 AbstractListHolderStateObject<StateObject>

Parameters:

children - The list used to store the children

addNot

public InExpressionStateObject addNot()

Makes sure the NOT identifier is specified.

Returns:

This object

getExpression

public InExpression 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)

getStateObject

public StateObject getStateObject()

Returns

Returns:

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

hasStateObject

public boolean hasStateObject()

Determines whether

Returns:

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

isSingleInputParameter

public boolean isSingleInputParameter()

Determines whether what was parsed after the IN identifier is a single input parameter.

Returns:

true if the only item is an input parameter; false otherwise

listName

protected java.lang.String listName()

Returns the name that is uniquely identifying the list.

Specified by:

listName in class AbstractListHolderStateObject<StateObject>

Returns:

The unique name identifying the list

parse

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

Parameters:

jpqlFragment - The portion of the query to parse

removeNot

public void removeNot()

Makes sure the NOT identifier is not specified.

setExpression

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

Parameters:

expression - The parsed object representing an IN 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

setSingleInputParameter

public void setSingleInputParameter(boolean singleInputParameter)

Sets whether what was parsed after the IN 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 the NOT 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