Class AbstractTripleEncapsulatedExpressionStateObject
- 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.AbstractTripleEncapsulatedExpressionStateObject
-
- All Implemented Interfaces:
StateObject
- Direct Known Subclasses:
LocateExpressionStateObject,SubstringExpressionStateObject
public abstract class AbstractTripleEncapsulatedExpressionStateObject extends AbstractEncapsulatedExpressionStateObject
This state object takes care of parsing an expression that encapsulates three expressions separated by a comma.BNF:expression ::= <identifier>(first_expression, second_expression, third_expression)- Version:
- 2.4
- See Also:
LocateExpressionStateObject,SubstringExpressionStateObject,AbstractTripleEncapsulatedExpression- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringFIRST_STATE_OBJECT_PROPERTYNotifies the firstStateObjectproperty has changed.static java.lang.StringSECOND_STATE_OBJECT_PROPERTYNotifies the secondStateObjectproperty has changed.static java.lang.StringTHIRD_STATE_OBJECT_PROPERTYNotifies the thirdStateObjectproperty has changed.
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractTripleEncapsulatedExpressionStateObject(StateObject parent)Creates a newAbstractTripleEncapsulatedExpressionStateObject.protectedAbstractTripleEncapsulatedExpressionStateObject(StateObject parent, java.lang.String firstJpqlFragment, java.lang.String secondJpqlFragment, java.lang.String thirdJpqlFragment)Creates a newAbstractTripleEncapsulatedExpressionStateObject.protectedAbstractTripleEncapsulatedExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject, StateObject thirdStateObject)Creates a newAbstractTripleEncapsulatedExpressionStateObject.
-
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.AbstractTripleEncapsulatedExpressiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.StateObjectgetFirst()Returns theStateObjectrepresenting the first expression.protected abstract java.lang.StringgetFirstQueryBNFId()Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the first encapsulated expression.StateObjectgetSecond()Returns theStateObjectrepresenting the second expression.protected abstract java.lang.StringgetSecondQueryBNFId()Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the second encapsulated expression.StateObjectgetThird()Returns theStateObjectrepresenting the third expression.protected abstract java.lang.StringgetThirdQueryBNFId()Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the third encapsulated expression.booleanhasFirst()Determines whether theStateObjectrepresenting the first encapsulated expression is present or not.booleanhasSecond()Determines whether theStateObjectrepresenting the second encapsulated expression is present or not.booleanhasThird()Determines whether theStateObjectrepresenting the third 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.voidparseFirst(java.lang.String jpqlFragment)Parses the given JPQL fragment, which will represent the first encapsulated expression.voidparseSecond(java.lang.String jpqlFragment)Parses the given JPQL fragment, which will represent the second encapsulated expression.voidparseThird(java.lang.String jpqlFragment)Parses the given JPQL fragment, which will represent the third encapsulated expression.voidsetFirst(StateObject firstStateObject)Sets the givenStateObjectto represent the first encapsulated expression.voidsetSecond(StateObject secondStateObject)Sets the givenStateObjectto represent the second encapsulated expression.voidsetThird(StateObject thirdStateObject)Sets the givenStateObjectto represent the third 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
-
FIRST_STATE_OBJECT_PROPERTY
public static final java.lang.String FIRST_STATE_OBJECT_PROPERTY
Notifies the firstStateObjectproperty has changed.- See Also:
- Constant Field Values
-
SECOND_STATE_OBJECT_PROPERTY
public static final java.lang.String SECOND_STATE_OBJECT_PROPERTY
Notifies the secondStateObjectproperty has changed.- See Also:
- Constant Field Values
-
THIRD_STATE_OBJECT_PROPERTY
public static final java.lang.String THIRD_STATE_OBJECT_PROPERTY
Notifies the thirdStateObjectproperty has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AbstractTripleEncapsulatedExpressionStateObject
protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent)
Creates a newAbstractTripleEncapsulatedExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
AbstractTripleEncapsulatedExpressionStateObject
protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject, StateObject thirdStateObject)
Creates a newAbstractTripleEncapsulatedExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullfirstStateObject- TheStateObjectof the first encapsulated expressionsecondStateObject- TheStateObjectof the second encapsulated expressionthirdStateObject- TheStateObjectof the third encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
AbstractTripleEncapsulatedExpressionStateObject
protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, java.lang.String firstJpqlFragment, java.lang.String secondJpqlFragment, java.lang.String thirdJpqlFragment)
Creates a newAbstractTripleEncapsulatedExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullfirstJpqlFragment- The string representation of the first encapsulated expression to parse and to convert into aStateObjectrepresentationsecondJpqlFragment- The string representation of the second encapsulated expression to parse and to convert into aStateObjectrepresentationthirdJpqlFragment- The string representation of the third encapsulated expression to parse and to convert into aStateObjectrepresentation- 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 AbstractTripleEncapsulatedExpression 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)
-
getFirst
public StateObject getFirst()
Returns theStateObjectrepresenting the first expression.- Returns:
- The first encapsulated
StateObjectornullif none exists
-
getFirstQueryBNFId
protected abstract java.lang.String getFirstQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the first encapsulated expression.- Returns:
- The query BNF ID for the first encapsulated expression
-
getSecond
public StateObject getSecond()
Returns theStateObjectrepresenting the second expression.- Returns:
- The second encapsulated
StateObjectornullif none exists
-
getSecondQueryBNFId
protected abstract java.lang.String getSecondQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the second encapsulated expression.- Returns:
- The query BNF ID for the second encapsulated expression
-
getThird
public StateObject getThird()
Returns theStateObjectrepresenting the third expression.- Returns:
- The third encapsulated
StateObjectornullif none exists
-
getThirdQueryBNFId
protected abstract java.lang.String getThirdQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the third encapsulated expression.- Returns:
- The query BNF ID for the third encapsulated expression
-
hasFirst
public boolean hasFirst()
Determines whether theStateObjectrepresenting the first encapsulated expression is present or not.- Returns:
trueif the firstStateObjectis notnull;falseotherwise
-
hasSecond
public boolean hasSecond()
Determines whether theStateObjectrepresenting the second encapsulated expression is present or not.- Returns:
trueif the secondStateObjectis notnull;falseotherwise
-
hasThird
public boolean hasThird()
Determines whether theStateObjectrepresenting the third encapsulated expression is present or not.- Returns:
trueif the thirdStateObjectis 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
-
parseFirst
public void parseFirst(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which will represent the first encapsulated expression.- Parameters:
jpqlFragment- The string representation of the first encapsulated expression to parse and to convert into aStateObjectrepresentation
-
parseSecond
public void parseSecond(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which will represent the second encapsulated expression.- Parameters:
jpqlFragment- The string representation of the second encapsulated expression to parse and to convert into aStateObjectrepresentation
-
parseThird
public void parseThird(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which will represent the third encapsulated expression.- Parameters:
jpqlFragment- The string representation of the third encapsulated expression to parse and to convert into aStateObjectrepresentation
-
setFirst
public void setFirst(StateObject firstStateObject)
Sets the givenStateObjectto represent the first encapsulated expression.- Parameters:
firstStateObject- The new encapsulatedStateObjectrepresenting the first expression
-
setSecond
public void setSecond(StateObject secondStateObject)
Sets the givenStateObjectto represent the second encapsulated expression.- Parameters:
secondStateObject- The new encapsulatedStateObjectrepresenting the second expression
-
setThird
public void setThird(StateObject thirdStateObject)
Sets the givenStateObjectto represent the third encapsulated expression.- Parameters:
thirdStateObject- The new encapsulatedStateObjectrepresenting the third expression
-
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
-
-