Class AbstractSingleEncapsulatedExpressionStateObject
java.lang.Object
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
- All Implemented Interfaces:
StateObject
- Direct Known Subclasses:
AbsExpressionStateObject
,AggregateFunctionStateObject
,AllOrAnyExpressionStateObject
,EncapsulatedIdentificationVariableExpressionStateObject
,ExistsExpressionStateObject
,LengthExpressionStateObject
,LowerExpressionStateObject
,SizeExpressionStateObject
,SqrtExpressionStateObject
,SubExpressionStateObject
,TrimExpressionStateObject
,TypeExpressionStateObject
,UpperExpressionStateObject
public abstract class AbstractSingleEncapsulatedExpressionStateObject
extends AbstractEncapsulatedExpressionStateObject
This
StateObject
represents a JPQL expression that has a JPQL identifier followed by
an encapsulated expression with parenthesis.
BNF: expression ::= <identifier>(expression)
- Since:
- 2.4
- Version:
- 2.4
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Notifies the encapsulatedStateObject
has changed. -
Constructor Summary
ModifierConstructorDescriptionprotected
Creates a newAbstractSingleEncapsulatedExpressionStateObject
.protected
AbstractSingleEncapsulatedExpressionStateObject
(StateObject parent, String jpqlFragment) Creates a newAbstractSingleEncapsulatedExpressionStateObject
.protected
AbstractSingleEncapsulatedExpressionStateObject
(StateObject parent, StateObject stateObject) Creates a newAbstractSingleEncapsulatedExpressionStateObject
. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addChildren
(List<StateObject> children) Adds the children of thisStateObject
to the given list.Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.protected abstract String
Returns the unique identifier of theJPQLQueryBNF
that will determine how to parse the encapsulated expression.Returns the encapsulatedStateObject
.boolean
Determines whether theStateObject
representing the encapsulated expression is present or not.boolean
isEquivalent
(StateObject stateObject) Determines whether the givenStateObject
is equivalent to this one, i.e.void
Parses the given JPQL fragment, which represents the encapsulated expression, and creates theStateObject
.protected void
setStateObject
(StateObject stateObject) Sets the givenStateObject
to represent the new encapsulated expression.protected void
Prints out a string representation of this encapsulated information, which should not be used to define atrue
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.AbstractEncapsulatedExpressionStateObject
getIdentifier, toTextInternal
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, 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
Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
accept
-
Field Details
-
STATE_OBJECT_PROPERTY
Notifies the encapsulatedStateObject
has changed.- See Also:
-
-
Constructor Details
-
AbstractSingleEncapsulatedExpressionStateObject
Creates a newAbstractSingleEncapsulatedExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
NullPointerException
- The given parent cannot benull
-
AbstractSingleEncapsulatedExpressionStateObject
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, StateObject stateObject) Creates a newAbstractSingleEncapsulatedExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stateObject
- TheStateObject
representing the encapsulated expression- Throws:
NullPointerException
- The given parent cannot benull
-
AbstractSingleEncapsulatedExpressionStateObject
Creates a newAbstractSingleEncapsulatedExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
jpqlFragment
- The portion of the query representing the encapsulated expression- Throws:
NullPointerException
- The given parent cannot benull
-
-
Method Details
-
addChildren
Description copied from class:AbstractStateObject
Adds the children of thisStateObject
to the given list.- Overrides:
addChildren
in classAbstractStateObject
- Parameters:
children
- The list used to store the children
-
getExpression
Description copied from interface:StateObject
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 classAbstractEncapsulatedExpressionStateObject
- 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)
-
getQueryBNFId
Returns the unique identifier of theJPQLQueryBNF
that will determine how to parse the encapsulated expression.- Returns:
- The non-
null
ID of the BNF
-
getStateObject
Returns the encapsulatedStateObject
.- Returns:
- The encapsulated
StateObject
-
hasStateObject
public boolean hasStateObject()Determines whether theStateObject
representing the encapsulated expression is present or not.- Returns:
true
if the encapsulatedStateObject
is notnull
;false
otherwise
-
isEquivalent
Description copied from interface: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
-
parse
Parses the given JPQL fragment, which represents the encapsulated expression, and creates theStateObject
.- Parameters:
jpqlFragment
- The portion of the query representing the encapsulated expression
-
setStateObject
Sets the givenStateObject
to represent the new encapsulated expression.- Parameters:
stateObject
- The new encapsulatedStateObject
-
toTextEncapsulatedExpression
Description copied from class:AbstractEncapsulatedExpressionStateObject
Prints out a string representation of this encapsulated information, which should not be used to define atrue
string representation of a JPQL query but should be used for debugging purposes.- Specified by:
toTextEncapsulatedExpression
in classAbstractEncapsulatedExpressionStateObject
- Parameters:
writer
- The writer used to print out the string representation of the encapsulated information- Throws:
IOException
- This should never happens, only required becauseAppendable
is used instead ofStringBuilder
for instance
-