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

Modifier and Type	Field and Description
public static final String	STATE_OBJECT_PROPERTY Notifies the encapsulated `StateObject` has changed.
private StateObject	stateObject The `StateObject` representing the encapsulated expression.

Constructor Summary

Access	Constructor and Description
protected	AbstractSingleEncapsulatedExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `AbstractSingleEncapsulatedExpressionStateObject`.
protected	AbstractSingleEncapsulatedExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, StateObject The `StateObject` representing the encapsulated expression stateObject) Creates a new `AbstractSingleEncapsulatedExpressionStateObject`.
protected	AbstractSingleEncapsulatedExpressionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String The portion of the query representing the encapsulated expression jpqlFragment) Creates a new `AbstractSingleEncapsulatedExpressionStateObject`.

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 AbstractSingleEncapsulatedExpression	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.
protected abstract String	Returns: The non-`null` ID of the BNF getQueryBNFId() Returns the unique identifier of the `JPQLQueryBNF` that will determine how to parse the encapsulated expression.
public StateObject	Returns: The encapsulated `StateObject` getStateObject() Returns the encapsulated `StateObject`.
public boolean	Returns: `true` if the encapsulated `StateObject` is not `null`; `false` otherwise hasStateObject() Determines whether the `StateObject` representing the 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	parse(String The portion of the query representing the encapsulated expression jpqlFragment) Parses the given JPQL fragment, which represents the encapsulated expression, and creates the `StateObject`.
protected void	setStateObject(StateObject The new encapsulated `StateObject` stateObject) Sets the given `StateObject` to represent the new 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

STATE_OBJECT_PROPERTY	back to summary
public static final String STATE_OBJECT_PROPERTY Notifies the encapsulated `StateObject` has changed.

stateObject	back to summary
private StateObject stateObject The `StateObject` representing the encapsulated expression.

Constructor Detail

AbstractSingleEncapsulatedExpressionStateObject back to summary

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

protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent)

Creates a new AbstractSingleEncapsulatedExpressionStateObject.

Parameters

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

Exceptions

NullPointerException:: The given parent cannot be null

AbstractSingleEncapsulatedExpressionStateObject back to summary

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

protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, StateObject stateObject)

Creates a new AbstractSingleEncapsulatedExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
stateObject:StateObject: The StateObject representing the encapsulated expression

Exceptions

NullPointerException:: The given parent cannot be null

AbstractSingleEncapsulatedExpressionStateObject back to summary

AbstractSingleEncapsulatedExpressionStateObject	back to summary
protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, String jpqlFragment) Creates a new `AbstractSingleEncapsulatedExpressionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` jpqlFragment:String The portion of the query representing the encapsulated expression Exceptions NullPointerException: The given parent cannot be `null`

protected AbstractSingleEncapsulatedExpressionStateObject(StateObject parent, String jpqlFragment)

Creates a new AbstractSingleEncapsulatedExpressionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
jpqlFragment:String: The portion of the query representing the encapsulated expression

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 AbstractSingleEncapsulatedExpression 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:AbstractSingleEncapsulatedExpression 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 AbstractSingleEncapsulatedExpression 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:AbstractSingleEncapsulatedExpression

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

getQueryBNFId back to summary

getQueryBNFId	back to summary
protected abstract String getQueryBNFId() Returns the unique identifier of the `JPQLQueryBNF` that will determine how to parse the encapsulated expression. Returns:String The non-`null` ID of the BNF

protected abstract String getQueryBNFId()

Returns the unique identifier of the JPQLQueryBNF that will determine how to parse the encapsulated expression.

Returns:String: The non-null ID of the BNF

getStateObject back to summary

getStateObject	back to summary
public StateObject getStateObject() Returns the encapsulated `StateObject`. Returns:StateObject The encapsulated `StateObject`

public StateObject getStateObject()

Returns the encapsulated StateObject.

Returns:StateObject: The encapsulated StateObject

hasStateObject back to summary

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

public boolean hasStateObject()

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

Returns:boolean: true if the encapsulated 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

parse back to summary

parse	back to summary
public void parse(String jpqlFragment) Parses the given JPQL fragment, which represents the encapsulated expression, and creates the `StateObject`. Parameters jpqlFragment:String The portion of the query representing the encapsulated expression

public void parse(String jpqlFragment)

Parses the given JPQL fragment, which represents the encapsulated expression, and creates the StateObject.

Parameters

jpqlFragment:String: The portion of the query representing the encapsulated expression

setStateObject back to summary

setStateObject	back to summary
protected void setStateObject(StateObject stateObject) Sets the given `StateObject` to represent the new encapsulated expression. Parameters stateObject:StateObject The new encapsulated `StateObject`

protected void setStateObject(StateObject stateObject)

Sets the given StateObject to represent the new encapsulated expression.

Parameters

stateObject:StateObject: The new encapsulated StateObject

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 AbstractSingleEncapsulatedExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail