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

Class InputParameterStateObject

java.lang.Object

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

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

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

All Implemented Interfaces:

StateObject

public class InputParameterStateObject
extends SimpleStateObject

Either positional or named parameters may be used. Positional and named parameters may not be mixed in a single query. Input parameters can only be used in the WHERE clause or HAVING clause of a query.

Version:

2.4

See Also:

InputParameter

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject

TEXT_PROPERTY

Constructor Summary

Constructors

Constructor	Description
InputParameterStateObject(StateObject parent)	Creates a new InputParameterStateObject.
InputParameterStateObject(StateObject parent, java.lang.String parameter)	Creates a new InputParameterStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
InputParameter	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
boolean	isNamed()	Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.
boolean	isPositional()	Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.
void	setExpression(InputParameter 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.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.SimpleStateObject

getText, hasText, isEquivalent, setText, setTextInternally, toTextInternal

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

acceptUnknownVisitor, acceptUnknownVisitor, addChildren, 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, initialize, 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

Constructor Detail

InputParameterStateObject

public InputParameterStateObject(StateObject parent)

Creates a new InputParameterStateObject.

Parameters:

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

Throws:

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

InputParameterStateObject

public InputParameterStateObject(StateObject parent,
                                 java.lang.String parameter)

Creates a new InputParameterStateObject.

Parameters:

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

parameter - The positional or named input parameter

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

getExpression

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

isNamed

public boolean isNamed()

Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.

Returns:

true if the parameter type is '?'; false if it's ':'

isPositional

public boolean isPositional()

Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.

Returns:

true if the parameter type is ':'; false if it's '?'

setExpression

public void setExpression(InputParameter 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 input parameter