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

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.String	FIRST_STATE_OBJECT_PROPERTY	Notifies the first StateObject property has changed.
static java.lang.String	SECOND_STATE_OBJECT_PROPERTY	Notifies the second StateObject property has changed.
static java.lang.String	THIRD_STATE_OBJECT_PROPERTY	Notifies the third StateObject property has changed.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTripleEncapsulatedExpressionStateObject(StateObject parent)	Creates a new AbstractTripleEncapsulatedExpressionStateObject.
protected	AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, java.lang.String firstJpqlFragment, java.lang.String secondJpqlFragment, java.lang.String thirdJpqlFragment)	Creates a new AbstractTripleEncapsulatedExpressionStateObject.
protected	AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject, StateObject thirdStateObject)	Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
protected void	addChildren(java.util.List<StateObject> children)	Adds the children of this StateObject to the given list.
AbstractTripleEncapsulatedExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
StateObject	getFirst()	Returns the StateObject representing the first expression.
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.
StateObject	getSecond()	Returns the StateObject representing the second expression.
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.
StateObject	getThird()	Returns the StateObject representing the third expression.
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.
boolean	hasFirst()	Determines whether the StateObject representing the first encapsulated expression is present or not.
boolean	hasSecond()	Determines whether the StateObject representing the second encapsulated expression is present or not.
boolean	hasThird()	Determines whether the StateObject representing the third encapsulated expression is present or not.
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	parseFirst(java.lang.String jpqlFragment)	Parses the given JPQL fragment, which will represent the first encapsulated expression.
void	parseSecond(java.lang.String jpqlFragment)	Parses the given JPQL fragment, which will represent the second encapsulated expression.
void	parseThird(java.lang.String jpqlFragment)	Parses the given JPQL fragment, which will represent the third encapsulated expression.
void	setFirst(StateObject firstStateObject)	Sets the given StateObject to represent the first encapsulated expression.
void	setSecond(StateObject secondStateObject)	Sets the given StateObject to represent the second encapsulated expression.
void	setThird(StateObject thirdStateObject)	Sets the given StateObject to represent the third encapsulated expression.
protected void	toTextEncapsulatedExpression(java.lang.Appendable writer)	Prints out a string representation of this encapsulated information, 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.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 first StateObject property has changed.

See Also:

Constant Field Values

SECOND_STATE_OBJECT_PROPERTY

public static final java.lang.String SECOND_STATE_OBJECT_PROPERTY

Notifies the second StateObject property has changed.

See Also:

Constant Field Values

THIRD_STATE_OBJECT_PROPERTY

public static final java.lang.String THIRD_STATE_OBJECT_PROPERTY

Notifies the third StateObject property has changed.

See Also:

Constant Field Values

Constructor Detail

AbstractTripleEncapsulatedExpressionStateObject

protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent)

Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Parameters:

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

Throws:

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

AbstractTripleEncapsulatedExpressionStateObject

protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent,
                                                          StateObject firstStateObject,
                                                          StateObject secondStateObject,
                                                          StateObject thirdStateObject)

Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Parameters:

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

firstStateObject - The StateObject of the first encapsulated expression

secondStateObject - The StateObject of the second encapsulated expression

thirdStateObject - The StateObject of the third encapsulated expression

Throws:

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

AbstractTripleEncapsulatedExpressionStateObject

protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent,
                                                          java.lang.String firstJpqlFragment,
                                                          java.lang.String secondJpqlFragment,
                                                          java.lang.String thirdJpqlFragment)

Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Parameters:

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

firstJpqlFragment - The string representation of the first encapsulated expression to parse and to convert into a StateObject representation

secondJpqlFragment - The string representation of the second encapsulated expression to parse and to convert into a StateObject representation

thirdJpqlFragment - The string representation of the third encapsulated expression to parse and to convert into a StateObject representation

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 AbstractTripleEncapsulatedExpression 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 AbstractEncapsulatedExpressionStateObject

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)

getFirst

public StateObject getFirst()

Returns the StateObject representing the first expression.

Returns:

The first encapsulated StateObject or null if 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 the StateObject representing the second expression.

Returns:

The second encapsulated StateObject or null if 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 the StateObject representing the third expression.

Returns:

The third encapsulated StateObject or null if 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 the StateObject representing the first encapsulated expression is present or not.

Returns:

true if the first StateObject is not null; false otherwise

hasSecond

public boolean hasSecond()

Determines whether the StateObject representing the second encapsulated expression is present or not.

Returns:

true if the second StateObject is not null; false otherwise

hasThird

public boolean hasThird()

Determines whether the StateObject representing the third encapsulated expression is present or not.

Returns:

true if the third StateObject is not null; false otherwise

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

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 a StateObject representation

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 a StateObject representation

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 a StateObject representation

setFirst

public void setFirst(StateObject firstStateObject)

Sets the given StateObject to represent the first encapsulated expression.

Parameters:

firstStateObject - The new encapsulated StateObject representing the first expression

setSecond

public void setSecond(StateObject secondStateObject)

Sets the given StateObject to represent the second encapsulated expression.

Parameters:

secondStateObject - The new encapsulated StateObject representing the second expression

setThird

public void setThird(StateObject thirdStateObject)

Sets the given StateObject to represent the third encapsulated expression.

Parameters:

thirdStateObject - The new encapsulated StateObject representing the third expression

toTextEncapsulatedExpression

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

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

Specified by:

toTextEncapsulatedExpression in class AbstractEncapsulatedExpressionStateObject

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 because Appendable is used instead of StringBuilder for instance