org.eclipse.persistence.jpa.jpql.tools.model.query

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 compound StateObject has 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 and Description
static java.lang.String	LEFT_STATE_OBJECT_PROPERTY Notifies the left state object property has changed.
static java.lang.String	RIGHT_STATE_OBJECT_PROPERTY Notifies the right state object property has changed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompoundExpressionStateObject(StateObject parent) Creates a new CompoundExpressionStateObject.
protected	CompoundExpressionStateObject(StateObject parent, StateObject leftStateObject, StateObject rightStateObject) Creates a new ArithmeticExpressionStateObject.
protected	CompoundExpressionStateObject(StateObject parent, java.lang.String leftJpqlFragment, java.lang.String rightJpqlFragment) Creates a new ArithmeticExpressionStateObject.

Method Summary

Modifier and Type	Method and Description
protected void	addChildren(java.util.List<StateObject> children) Adds the children of this StateObject to the given list.
CompoundExpression	getExpression() Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
abstract java.lang.String	getIdentifier() Returns the identifier joining the two StateObjects.
StateObject	getLeft() Returns the StateObject that represents the left expression.
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.
StateObject	getRight() Returns the StateObject that represents the right expression.
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.
boolean	hasLeft() Determines whether there is a StateObject that represents the left expression.
boolean	hasRight() Determines whether there is a StateObject that represents the right expression.
boolean	isEquivalent(StateObject stateObject) Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
void	parseLeft(java.lang.String jpqlFragment) Parses the given JPQL fragment and update the left side of the compound expression.
void	parseRight(java.lang.String jpqlFragment) Parses the given JPQL fragment and update the right side of the compound expression.
void	setLeft(StateObject leftStateObject) Sets the left StateObject to become the given object.
void	setRight(StateObject rightStateObject) Sets the right StateObject to become the given object.
protected void	toTextInternal(java.lang.Appendable writer) Prints out a string representation of this StateObject, which should not be used to define a true 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.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 new CompoundExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

java.lang.NullPointerException - The given parent cannot be null

CompoundExpressionStateObject

protected CompoundExpressionStateObject(StateObject parent,
                                        StateObject leftStateObject,
                                        StateObject rightStateObject)

Creates a new ArithmeticExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

leftStateObject - The StateObject representing the left expression

rightStateObject - The StateObject representing the right expression

Throws:

java.lang.NullPointerException - The given parent cannot be null

CompoundExpressionStateObject

protected CompoundExpressionStateObject(StateObject parent,
                                        java.lang.String leftJpqlFragment,
                                        java.lang.String rightJpqlFragment)

Creates a new ArithmeticExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

leftJpqlFragment - The string representation of the left expression to parse and to convert into a StateObject

rightJpqlFragment - The string representation of the right expression to parse and to convert into a StateObject

Throws:

java.lang.NullPointerException - The given parent cannot be null

Method Detail

addChildren

protected void addChildren(java.util.List<StateObject> children)

Adds the children of this StateObject to the given list.

Overrides:

addChildren in class AbstractStateObject

Parameters:

children - The list used to store the children

getExpression

public CompoundExpression getExpression()

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Specified by:

getExpression in interface StateObject

Overrides:

getExpression in class AbstractStateObject

Returns:

The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

getIdentifier

public abstract java.lang.String getIdentifier()

Returns the identifier joining the two StateObjects.

Returns:

The JPQL identifier join two expressions

getLeft

public StateObject getLeft()

Returns the StateObject that represents the left expression.

Returns:

The StateObject representing 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 the StateObject that represents the right expression.

Returns:

The StateObject representing 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 a StateObject that represents the left expression.

Returns:

true if there is a left StateObject; false if it is null

hasRight

public boolean hasRight()

Determines whether there is a StateObject that represents the right expression.

Returns:

true if there is a right StateObject; false if it is null

isEquivalent

public boolean isEquivalent(StateObject stateObject)

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Specified by:

isEquivalent in interface StateObject

Overrides:

isEquivalent in class AbstractStateObject

Parameters:

stateObject - The StateObject to compare its content to this one

Returns:

true if both object are equivalent; false otherwise

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 left StateObject to become the given object.

Parameters:

leftStateObject - The StateObject representing the left expression

setRight

public void setRight(StateObject rightStateObject)

Sets the right StateObject to become the given object.

Parameters:

rightStateObject - The StateObject representing the right expression

toTextInternal

protected void toTextInternal(java.lang.Appendable writer)
                       throws java.io.IOException

Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Specified by:

toTextInternal in class AbstractStateObject

Parameters:

writer - The writer used to print out the string representation

Throws:

java.io.IOException - This should never happens, it is only required because Appendable is used instead of any concrete class