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 theWHEREclause orHAVINGclause 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 newInputParameterStateObject.InputParameterStateObject(StateObject parent, java.lang.String parameter)Creates a newInputParameterStateObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StateObjectVisitor visitor)Visits thisStateObjectby the givenvisitor.InputParametergetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.booleanisNamed()Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.booleanisPositional()Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.voidsetExpression(InputParameter expression)Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.-
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
-
-
-
-
Constructor Detail
-
InputParameterStateObject
public InputParameterStateObject(StateObject parent)
Creates a newInputParameterStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
InputParameterStateObject
public InputParameterStateObject(StateObject parent, java.lang.String parameter)
Creates a newInputParameterStateObject.- Parameters:
parent- The parent of this state object, which cannot benullparameter- The positional or named input parameter- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObjectby the givenvisitor.- Parameters:
visitor- Thevisitorto visit this object
-
getExpression
public InputParameter getExpression()
Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpressionin interfaceStateObject- Overrides:
getExpressionin classAbstractStateObject- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObjectornullwhen 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:
trueif the parameter type is '?';falseif it's ':'
-
isPositional
public boolean isPositional()
Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.- Returns:
trueif the parameter type is ':';falseif it's '?'
-
setExpression
public void setExpression(InputParameter expression)
Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.- Parameters:
expression- Theparsed objectrepresenting an input parameter
-
-