EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractTripleEncapsulatedExpressionStateObject

Modifier and Type	Field and Description
public static final String	FIRST_STATE_OBJECT_PROPERTY Notifies the first `StateObject` property has changed.
private StateObject	firstStateObject The `StateObject` representing the first expression.
public static final String	SECOND_STATE_OBJECT_PROPERTY Notifies the second `StateObject` property has changed.
private StateObject	secondStateObject The `StateObject` representing the second expression.
public static final String	THIRD_STATE_OBJECT_PROPERTY Notifies the third `StateObject` property has changed.
private StateObject	thirdStateObject The `StateObject` representing the third expression.

Access	Constructor and Description
protected	AbstractTripleEncapsulatedExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `AbstractTripleEncapsulatedExpressionStateObject`.
protected	AbstractTripleEncapsulatedExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, StateObject The `StateObject` of the first encapsulated expression firstStateObject, StateObject The `StateObject` of the second encapsulated expression secondStateObject, StateObject The `StateObject` of the third encapsulated expression thirdStateObject) Creates a new `AbstractTripleEncapsulatedExpressionStateObject`.
protected	AbstractTripleEncapsulatedExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The string representation of the first encapsulated expression to parse and to convert into a `StateObject` representation firstJpqlFragment, String The string representation of the second encapsulated expression to parse and to convert into a `StateObject` representation secondJpqlFragment, String The string representation of the third encapsulated expression to parse and to convert into a `StateObject` representation thirdJpqlFragment) Creates a new `AbstractTripleEncapsulatedExpressionStateObject`.

Method Summary

Modifier and Type	Method and Description
protected void	addChildren(List<StateObject> The list used to store the children children) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Adds the children of this `StateObject` to the given list.
public AbstractTripleEncapsulatedExpression	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
public StateObject	Returns: The first encapsulated `StateObject` or `null` if none exists getFirst() Returns the `StateObject` representing the first expression.
protected abstract String	Returns: The query BNF ID for the first encapsulated expression getFirstQueryBNFId() Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the first encapsulated expression.
public StateObject	Returns: The second encapsulated `StateObject` or `null` if none exists getSecond() Returns the `StateObject` representing the second expression.
protected abstract String	Returns: The query BNF ID for the second encapsulated expression getSecondQueryBNFId() Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the second encapsulated expression.
public StateObject	Returns: The third encapsulated `StateObject` or `null` if none exists getThird() Returns the `StateObject` representing the third expression.
protected abstract String	Returns: The query BNF ID for the third encapsulated expression getThirdQueryBNFId() Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the third encapsulated expression.
public boolean	Returns: `true` if the first `StateObject` is not `null`; `false` otherwise hasFirst() Determines whether the `StateObject` representing the first encapsulated expression is present or not.
public boolean	Returns: `true` if the second `StateObject` is not `null`; `false` otherwise hasSecond() Determines whether the `StateObject` representing the second encapsulated expression is present or not.
public boolean	Returns: `true` if the third `StateObject` is not `null`; `false` otherwise hasThird() Determines whether the `StateObject` representing the third encapsulated expression is present or not.
public boolean	isEquivalent(StateObject The `StateObject` to compare its content to this one stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same.
public void	parseFirst(String The string representation of the first encapsulated expression to parse and to convert into a `StateObject` representation jpqlFragment) Parses the given JPQL fragment, which will represent the first encapsulated expression.
public void	parseSecond(String The string representation of the second encapsulated expression to parse and to convert into a `StateObject` representation jpqlFragment) Parses the given JPQL fragment, which will represent the second encapsulated expression.
public void	parseThird(String The string representation of the third encapsulated expression to parse and to convert into a `StateObject` representation jpqlFragment) Parses the given JPQL fragment, which will represent the third encapsulated expression.
public void	setFirst(StateObject The new encapsulated `StateObject` representing the first expression firstStateObject) Sets the given `StateObject` to represent the first encapsulated expression.
public void	setSecond(StateObject The new encapsulated `StateObject` representing the second expression secondStateObject) Sets the given `StateObject` to represent the second encapsulated expression.
public void	setThird(StateObject The new encapsulated `StateObject` representing the third expression thirdStateObject) Sets the given `StateObject` to represent the third encapsulated expression.
protected void	toTextEncapsulatedExpression(Appendable The writer used to print out the string representation of the encapsulated information writer) Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression. 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.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject:: getIdentifier toTextInternal

Field Detail

FIRST_STATE_OBJECT_PROPERTY	back to summary
public static final String FIRST_STATE_OBJECT_PROPERTY Notifies the first `StateObject` property has changed.

firstStateObject	back to summary
private StateObject firstStateObject The `StateObject` representing the first expression.

SECOND_STATE_OBJECT_PROPERTY	back to summary
public static final String SECOND_STATE_OBJECT_PROPERTY Notifies the second `StateObject` property has changed.

secondStateObject	back to summary
private StateObject secondStateObject The `StateObject` representing the second expression.

THIRD_STATE_OBJECT_PROPERTY	back to summary
public static final String THIRD_STATE_OBJECT_PROPERTY Notifies the third `StateObject` property has changed.

thirdStateObject	back to summary
private StateObject thirdStateObject The `StateObject` representing the third expression.

Constructor Detail

AbstractTripleEncapsulatedExpressionStateObject back to summary

AbstractTripleEncapsulatedExpressionStateObject	back to summary
protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent) Creates a new `AbstractTripleEncapsulatedExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` Exceptions NullPointerException: The given parent cannot be `null`

protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent)

Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null

Exceptions

NullPointerException:: The given parent cannot be null

AbstractTripleEncapsulatedExpressionStateObject back to summary

AbstractTripleEncapsulatedExpressionStateObject	back to summary
protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, StateObject firstStateObject, StateObject secondStateObject, StateObject thirdStateObject) Creates a new `AbstractTripleEncapsulatedExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` firstStateObject:StateObject The `StateObject` of the first encapsulated expression secondStateObject:StateObject The `StateObject` of the second encapsulated expression thirdStateObject:StateObject The `StateObject` of the third encapsulated expression Exceptions NullPointerException: The given parent cannot be `null`

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

Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
firstStateObject:StateObject: The StateObject of the first encapsulated expression
secondStateObject:StateObject: The StateObject of the second encapsulated expression
thirdStateObject:StateObject: The StateObject of the third encapsulated expression

Exceptions

NullPointerException:: The given parent cannot be null

AbstractTripleEncapsulatedExpressionStateObject back to summary

AbstractTripleEncapsulatedExpressionStateObject	back to summary
protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, String firstJpqlFragment, String secondJpqlFragment, String thirdJpqlFragment) Creates a new `AbstractTripleEncapsulatedExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` firstJpqlFragment:String The string representation of the first encapsulated expression to parse and to convert into a `StateObject` representation secondJpqlFragment:String The string representation of the second encapsulated expression to parse and to convert into a `StateObject` representation thirdJpqlFragment:String The string representation of the third encapsulated expression to parse and to convert into a `StateObject` representation Exceptions NullPointerException: The given parent cannot be `null`

protected AbstractTripleEncapsulatedExpressionStateObject(StateObject parent, String firstJpqlFragment, String secondJpqlFragment, String thirdJpqlFragment)

Creates a new AbstractTripleEncapsulatedExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
firstJpqlFragment:String: The string representation of the first encapsulated expression to parse and to convert into a StateObject representation
secondJpqlFragment:String: The string representation of the second encapsulated expression to parse and to convert into a StateObject representation
thirdJpqlFragment:String: The string representation of the third encapsulated expression to parse and to convert into a StateObject representation

Exceptions

NullPointerException:: The given parent cannot be null

Method Detail

addChildren back to summary

addChildren	back to summary
protected void addChildren(List<StateObject> children) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Adds the children of this `StateObject` to the given list. Parameters children:List<StateObject> The list used to store the children Annotations @Override

protected void addChildren(List<StateObject> children)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Adds the children of this StateObject to the given list.

Parameters

children:List<StateObject>: The list used to store the children

Annotations

@Override

getExpression back to summary

getExpression	back to summary
public AbstractTripleEncapsulatedExpression getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query. Returns:AbstractTripleEncapsulatedExpression 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) Annotations @Override

public AbstractTripleEncapsulatedExpression getExpression()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getExpression.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

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

Returns:AbstractTripleEncapsulatedExpression

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)

Annotations

@Override

getFirst back to summary

getFirst	back to summary
public StateObject getFirst() Returns the `StateObject` representing the first expression. Returns:StateObject The first encapsulated `StateObject` or `null` if none exists

public StateObject getFirst()

Returns the StateObject representing the first expression.

Returns:StateObject: The first encapsulated StateObject or null if none exists

getFirstQueryBNFId	back to summary
protected abstract String getFirstQueryBNFId() Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the first encapsulated expression. Returns:String The query BNF ID for the first encapsulated expression

getFirstQueryBNFId

back to summary

protected abstract String getFirstQueryBNFId()

Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the first encapsulated expression.

Returns:String: The query BNF ID for the first encapsulated expression

getSecond back to summary

getSecond	back to summary
public StateObject getSecond() Returns the `StateObject` representing the second expression. Returns:StateObject The second encapsulated `StateObject` or `null` if none exists

public StateObject getSecond()

Returns the StateObject representing the second expression.

Returns:StateObject: The second encapsulated StateObject or null if none exists

getSecondQueryBNFId	back to summary
protected abstract String getSecondQueryBNFId() Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the second encapsulated expression. Returns:String The query BNF ID for the second encapsulated expression

getSecondQueryBNFId

back to summary

protected abstract String getSecondQueryBNFId()

Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the second encapsulated expression.

Returns:String: The query BNF ID for the second encapsulated expression

getThird back to summary

getThird	back to summary
public StateObject getThird() Returns the `StateObject` representing the third expression. Returns:StateObject The third encapsulated `StateObject` or `null` if none exists

public StateObject getThird()

Returns the StateObject representing the third expression.

Returns:StateObject: The third encapsulated StateObject or null if none exists

getThirdQueryBNFId	back to summary
protected abstract String getThirdQueryBNFId() Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the third encapsulated expression. Returns:String The query BNF ID for the third encapsulated expression

getThirdQueryBNFId

back to summary

protected abstract String getThirdQueryBNFId()

Returns the unique identifier of the BNF that will be used to parse a JPQL fragment as the third encapsulated expression.

Returns:String: The query BNF ID for the third encapsulated expression

hasFirst back to summary

hasFirst	back to summary
public boolean hasFirst() Determines whether the `StateObject` representing the first encapsulated expression is present or not. Returns:boolean `true` if the first `StateObject` is not `null`; `false` otherwise

public boolean hasFirst()

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

Returns:boolean: true if the first StateObject is not null; false otherwise

hasSecond back to summary

hasSecond	back to summary
public boolean hasSecond() Determines whether the `StateObject` representing the second encapsulated expression is present or not. Returns:boolean `true` if the second `StateObject` is not `null`; `false` otherwise

public boolean hasSecond()

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

Returns:boolean: true if the second StateObject is not null; false otherwise

hasThird back to summary

hasThird	back to summary
public boolean hasThird() Determines whether the `StateObject` representing the third encapsulated expression is present or not. Returns:boolean `true` if the third `StateObject` is not `null`; `false` otherwise

public boolean hasThird()

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

Returns:boolean: true if the third StateObject is not null; false otherwise

isEquivalent back to summary

isEquivalent	back to summary
public boolean isEquivalent(StateObject stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same. Parameters stateObject:StateObject The `StateObject` to compare its content to this one Returns:boolean `true` if both object are equivalent; `false` otherwise Annotations @Override

public boolean isEquivalent(StateObject stateObject)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

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

Parameters

stateObject:StateObject: The StateObject to compare its content to this one

Returns:boolean

true if both object are equivalent; false otherwise

Annotations

@Override

parseFirst back to summary

parseFirst	back to summary
public void parseFirst(String jpqlFragment) Parses the given JPQL fragment, which will represent the first encapsulated expression. Parameters jpqlFragment:String The string representation of the first encapsulated expression to parse and to convert into a `StateObject` representation

public void parseFirst(String jpqlFragment)

Parses the given JPQL fragment, which will represent the first encapsulated expression.

Parameters

jpqlFragment:String: The string representation of the first encapsulated expression to parse and to convert into a StateObject representation

parseSecond back to summary

parseSecond	back to summary
public void parseSecond(String jpqlFragment) Parses the given JPQL fragment, which will represent the second encapsulated expression. Parameters jpqlFragment:String The string representation of the second encapsulated expression to parse and to convert into a `StateObject` representation

public void parseSecond(String jpqlFragment)

Parses the given JPQL fragment, which will represent the second encapsulated expression.

Parameters

jpqlFragment:String: The string representation of the second encapsulated expression to parse and to convert into a StateObject representation

parseThird back to summary

parseThird	back to summary
public void parseThird(String jpqlFragment) Parses the given JPQL fragment, which will represent the third encapsulated expression. Parameters jpqlFragment:String The string representation of the third encapsulated expression to parse and to convert into a `StateObject` representation

public void parseThird(String jpqlFragment)

Parses the given JPQL fragment, which will represent the third encapsulated expression.

Parameters

jpqlFragment:String: The string representation of the third encapsulated expression to parse and to convert into a StateObject representation

setFirst back to summary

setFirst	back to summary
public void setFirst(StateObject firstStateObject) Sets the given `StateObject` to represent the first encapsulated expression. Parameters firstStateObject:StateObject The new encapsulated `StateObject` representing the first expression

public void setFirst(StateObject firstStateObject)

Sets the given StateObject to represent the first encapsulated expression.

Parameters

firstStateObject:StateObject: The new encapsulated StateObject representing the first expression

setSecond back to summary

setSecond	back to summary
public void setSecond(StateObject secondStateObject) Sets the given `StateObject` to represent the second encapsulated expression. Parameters secondStateObject:StateObject The new encapsulated `StateObject` representing the second expression

public void setSecond(StateObject secondStateObject)

Sets the given StateObject to represent the second encapsulated expression.

Parameters

secondStateObject:StateObject: The new encapsulated StateObject representing the second expression

setThird back to summary

setThird	back to summary
public void setThird(StateObject thirdStateObject) Sets the given `StateObject` to represent the third encapsulated expression. Parameters thirdStateObject:StateObject The new encapsulated `StateObject` representing the third expression

public void setThird(StateObject thirdStateObject)

Sets the given StateObject to represent the third encapsulated expression.

Parameters

thirdStateObject:StateObject: The new encapsulated StateObject representing the third expression

toTextEncapsulatedExpression back to summary

toTextEncapsulatedExpression	back to summary
protected void toTextEncapsulatedExpression(Appendable writer) throws IOException Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression. 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. Parameters writer:Appendable The writer used to print out the string representation of the encapsulated information Annotations @Override Exceptions IOException: This should never happens, only required because `Appendable` is used instead of `StringBuilder` for instance

protected void toTextEncapsulatedExpression(Appendable writer) throws IOException

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression.

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.

Parameters

writer:Appendable: The writer used to print out the string representation of the encapsulated information

Annotations

@Override

Exceptions

IOException:: This should never happens, only required because Appendable is used instead of StringBuilder for instance

public abstract Class AbstractTripleEncapsulatedExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail