Class CompoundExpressionStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.CompoundExpressionStateObject
-
- All Implemented Interfaces:
StateObject
- Direct Known Subclasses:
ArithmeticExpressionStateObject,ComparisonExpressionStateObject,LogicalExpressionStateObject
public abstract class CompoundExpressionStateObject extends AbstractStateObject
A compoundStateObjecthas a left and right expressions combined by an identifier.BNF:expression ::= left_expression <identifier> right_expression- Version:
- 2.4
- See Also:
CompoundExpression- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringLEFT_STATE_OBJECT_PROPERTYNotifies the left state object property has changed.static java.lang.StringRIGHT_STATE_OBJECT_PROPERTYNotifies the right state object property has changed.
-
Constructor Summary
Constructors Modifier Constructor Description protectedCompoundExpressionStateObject(StateObject parent)Creates a newCompoundExpressionStateObject.protectedCompoundExpressionStateObject(StateObject parent, java.lang.String leftJpqlFragment, java.lang.String rightJpqlFragment)Creates a newArithmeticExpressionStateObject.protectedCompoundExpressionStateObject(StateObject parent, StateObject leftStateObject, StateObject rightStateObject)Creates a newArithmeticExpressionStateObject.
-
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.CompoundExpressiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.abstract java.lang.StringgetIdentifier()Returns the identifier joining the twoStateObjects.StateObjectgetLeft()Returns theStateObjectthat represents the left expression.protected abstract java.lang.StringgetLeftQueryBNFId()Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the left side of the expression.StateObjectgetRight()Returns theStateObjectthat represents the right expression.protected abstract java.lang.StringgetRightQueryBNFId()Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the right side of the expression.booleanhasLeft()Determines whether there is aStateObjectthat represents the left expression.booleanhasRight()Determines whether there is aStateObjectthat represents the right expression.booleanisEquivalent(StateObject stateObject)Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.voidparseLeft(java.lang.String jpqlFragment)Parses the given JPQL fragment and update the left side of the compound expression.voidparseRight(java.lang.String jpqlFragment)Parses the given JPQL fragment and update the right side of the compound expression.voidsetLeft(StateObject leftStateObject)Sets the leftStateObjectto become the given object.voidsetRight(StateObject rightStateObject)Sets the rightStateObjectto become the given object.protected voidtoTextInternal(java.lang.Appendable writer)Prints out a string representation of thisStateObject, 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.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
-
LEFT_STATE_OBJECT_PROPERTY
public static final java.lang.String LEFT_STATE_OBJECT_PROPERTY
Notifies the left state object property has changed.- See Also:
- Constant Field Values
-
RIGHT_STATE_OBJECT_PROPERTY
public static final java.lang.String RIGHT_STATE_OBJECT_PROPERTY
Notifies the right state object property has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CompoundExpressionStateObject
protected CompoundExpressionStateObject(StateObject parent)
Creates a newCompoundExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
CompoundExpressionStateObject
protected CompoundExpressionStateObject(StateObject parent, StateObject leftStateObject, StateObject rightStateObject)
Creates a newArithmeticExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullleftStateObject- TheStateObjectrepresenting the left expressionrightStateObject- TheStateObjectrepresenting the right expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
CompoundExpressionStateObject
protected CompoundExpressionStateObject(StateObject parent, java.lang.String leftJpqlFragment, java.lang.String rightJpqlFragment)
Creates a newArithmeticExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullleftJpqlFragment- The string representation of the left expression to parse and to convert into aStateObjectrightJpqlFragment- The string representation of the right expression to parse and to convert into aStateObject- 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 CompoundExpression 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)
-
getIdentifier
public abstract java.lang.String getIdentifier()
Returns the identifier joining the twoStateObjects.- Returns:
- The JPQL identifier join two expressions
-
getLeft
public StateObject getLeft()
Returns theStateObjectthat represents the left expression.- Returns:
- The
StateObjectrepresenting the left expression
-
getLeftQueryBNFId
protected abstract java.lang.String getLeftQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the left side of the expression.- Returns:
- The query BNF ID for the left side of the expression
-
getRight
public StateObject getRight()
Returns theStateObjectthat represents the right expression.- Returns:
- The
StateObjectrepresenting the right expression
-
getRightQueryBNFId
protected abstract java.lang.String getRightQueryBNFId()
Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the right side of the expression.- Returns:
- The query BNF ID for the right side of the expression
-
hasLeft
public boolean hasLeft()
Determines whether there is aStateObjectthat represents the left expression.- Returns:
trueif there is a leftStateObject;falseif it isnull
-
hasRight
public boolean hasRight()
Determines whether there is aStateObjectthat represents the right expression.- Returns:
trueif there is a rightStateObject;falseif it isnull
-
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
-
parseLeft
public void parseLeft(java.lang.String jpqlFragment)
Parses the given JPQL fragment and update the left side of the compound expression.- Parameters:
jpqlFragment- The portion of the query to become the left side of the compound expression
-
parseRight
public void parseRight(java.lang.String jpqlFragment)
Parses the given JPQL fragment and update the right side of the compound expression.- Parameters:
jpqlFragment- The portion of the query to become the right side of the compound expression
-
setLeft
public void setLeft(StateObject leftStateObject)
Sets the leftStateObjectto become the given object.- Parameters:
leftStateObject- TheStateObjectrepresenting the left expression
-
setRight
public void setRight(StateObject rightStateObject)
Sets the rightStateObjectto become the given object.- Parameters:
rightStateObject- TheStateObjectrepresenting the right expression
-
toTextInternal
protected void toTextInternal(java.lang.Appendable writer) throws java.io.IOExceptionPrints out a string representation of thisStateObject, which should not be used to define atruestring representation of a JPQL query but should be used for debugging purposes.- Specified by:
toTextInternalin classAbstractStateObject- Parameters:
writer- The writer used to print out the string representation- Throws:
java.io.IOException- This should never happens, it is only required becauseAppendableis used instead of any concrete class
-
-