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
ThisStateObjectrepresents a JPQL expression that has a JPQL identifier followed by an encapsulated expression with parenthesis.BNF:expression ::= <identifier>(expression)- Version:
- 2.4
- See Also:
AbstractSingleEncapsulatedExpression- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringSTATE_OBJECT_PROPERTYNotifies the encapsulatedStateObjecthas changed.
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractSingleEncapsulatedExpressionStateObject(StateObject parent)Creates a newAbstractSingleEncapsulatedExpressionStateObject.protectedAbstractSingleEncapsulatedExpressionStateObject(StateObject parent, java.lang.String jpqlFragment)Creates a newAbstractSingleEncapsulatedExpressionStateObject.protectedAbstractSingleEncapsulatedExpressionStateObject(StateObject parent, StateObject stateObject)Creates a newAbstractSingleEncapsulatedExpressionStateObject.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidaddChildren(java.util.List<StateObject> children)Adds the children of thisStateObjectto the given list.AbstractSingleEncapsulatedExpressiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.protected abstract java.lang.StringgetQueryBNFId()Returns the unique identifier of theJPQLQueryBNFthat will determine how to parse the encapsulated expression.StateObjectgetStateObject()Returns the encapsulatedStateObject.booleanhasStateObject()Determines whether theStateObjectrepresenting the encapsulated expression is present or not.booleanisEquivalent(StateObject stateObject)Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.voidparse(java.lang.String jpqlFragment)Parses the given JPQL fragment, which represents the encapsulated expression, and creates theStateObject.protected voidsetStateObject(StateObject stateObject)Sets the givenStateObjectto represent the new encapsulated expression.protected voidtoTextEncapsulatedExpression(java.lang.Appendable writer)Prints out a string representation of this encapsulated information, which should not be used to define atruestring 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 Detail
-
STATE_OBJECT_PROPERTY
public static final java.lang.String STATE_OBJECT_PROPERTY
Notifies the encapsulatedStateObjecthas changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AbstractSingleEncapsulatedExpressionStateObject
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent)
Creates a newAbstractSingleEncapsulatedExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.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 benullstateObject- TheStateObjectrepresenting the encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
AbstractSingleEncapsulatedExpressionStateObject
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, java.lang.String jpqlFragment)
Creates a newAbstractSingleEncapsulatedExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benulljpqlFragment- The portion of the query representing the encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
-
Method Detail
-
addChildren
protected void addChildren(java.util.List<StateObject> children)
Adds the children of thisStateObjectto the given list.- Overrides:
addChildrenin classAbstractStateObject- Parameters:
children- The list used to store the children
-
getExpression
public AbstractSingleEncapsulatedExpression 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 classAbstractEncapsulatedExpressionStateObject- 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)
-
getQueryBNFId
protected abstract java.lang.String getQueryBNFId()
Returns the unique identifier of theJPQLQueryBNFthat will determine how to parse the encapsulated expression.- Returns:
- The non-
nullID of the BNF
-
getStateObject
public StateObject getStateObject()
Returns the encapsulatedStateObject.- Returns:
- The encapsulated
StateObject
-
hasStateObject
public boolean hasStateObject()
Determines whether theStateObjectrepresenting the encapsulated expression is present or not.- Returns:
trueif the encapsulatedStateObjectis notnull;falseotherwise
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.- Specified by:
isEquivalentin interfaceStateObject- Overrides:
isEquivalentin classAbstractStateObject- Parameters:
stateObject- TheStateObjectto compare its content to this one- Returns:
trueif both object are equivalent;falseotherwise
-
parse
public void parse(java.lang.String jpqlFragment)
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
protected void setStateObject(StateObject stateObject)
Sets the givenStateObjectto represent the new encapsulated expression.- Parameters:
stateObject- The new encapsulatedStateObject
-
toTextEncapsulatedExpression
protected void toTextEncapsulatedExpression(java.lang.Appendable writer) throws java.io.IOExceptionPrints out a string representation of this encapsulated information, which should not be used to define atruestring representation of a JPQL query but should be used for debugging purposes.- Specified by:
toTextEncapsulatedExpressionin classAbstractEncapsulatedExpressionStateObject- Parameters:
writer- The writer used to print out the string representation of the encapsulated information- Throws:
java.io.IOException- This should never happens, only required becauseAppendableis used instead ofStringBuilderfor instance
-
-