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

Modifier and Type	Field and Description
private boolean	distinct Determines whether the `DISTINCT` keyword is part of the query, which is used to return only distinct (different) values.
public static final String	DISTINCT_PROPERTY Notifies the visibility of the `DISTINCT` identifier has changed.

Constructor Summary

Access	Constructor and Description
protected	AggregateFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `AggregateFunctionStateObject`.
protected	AggregateFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent, boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required distinct, StateObject The `StateObject` representing the encapsulated expression stateObject) Creates a new `AggregateStateObject`.
protected	AggregateFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent, boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required distinct, String Either the identification variable or the state field path expression path) Creates a new `AggregateFunctionStateObject`.
protected	AggregateFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent, StateObject The `StateObject` representing the encapsulated expression stateObject) Creates a new `AggregateStateObject`.
protected	AggregateFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent, String Either the identification variable or the state field path expression path) Creates a new `AggregateFunctionStateObject`.

Method Summary

Modifier and Type	Method and Description
public AggregateFunction	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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 boolean	Returns: `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required hasDistinct() Sets whether the `DISTINCT` keyword should be part of the query, which is used to return only distinct (different) values.
public boolean	isEquivalent(StateObject The `StateObject` to compare its content to this one stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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	setDistinct(boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required distinct) Sets whether the `DISTINCT` keyword should be part of the query, which is used to return only distinct (different) values
public void	setStateObject(StateObject The new encapsulated `StateObject` stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.setStateObject. Sets the given `StateObject` to represent the new encapsulated expression.
public void	toggleDistinct() Reverses the visibility of the `DISTINCT` identifier.
protected void	toTextEncapsulatedExpression(Appendable The writer used to print out the string representation of the encapsulated information writer) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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.AbstractSingleEncapsulatedExpressionStateObject:: addChildren getQueryBNFId getStateObject hasStateObject parse

Field Detail

distinct	back to summary
private boolean distinct Determines whether the `DISTINCT` keyword is part of the query, which is used to return only distinct (different) values.

DISTINCT_PROPERTY	back to summary
public static final String DISTINCT_PROPERTY Notifies the visibility of the `DISTINCT` identifier has changed.

Constructor Detail

AggregateFunctionStateObject back to summary

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

protected AggregateFunctionStateObject(StateObject parent)

Creates a new AggregateFunctionStateObject.

Parameters

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

Exceptions

NullPointerException:: The given parent cannot be null

AggregateFunctionStateObject back to summary

AggregateFunctionStateObject	back to summary
protected AggregateFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject) Creates a new `AggregateStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` distinct:boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required stateObject:StateObject The `StateObject` representing the encapsulated expression Exceptions NullPointerException: The given parent cannot be `null`

protected AggregateFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject)

Creates a new AggregateStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
distinct:boolean: true to add DISTINCT to the query in order to have distinct values; false if it is not required
stateObject:StateObject: The StateObject representing the encapsulated expression

Exceptions

NullPointerException:: The given parent cannot be null

AggregateFunctionStateObject back to summary

AggregateFunctionStateObject	back to summary
protected AggregateFunctionStateObject(StateObject parent, boolean distinct, String path) Creates a new `AggregateFunctionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` distinct:boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required path:String Either the identification variable or the state field path expression Exceptions NullPointerException: The given parent cannot be `null`

protected AggregateFunctionStateObject(StateObject parent, boolean distinct, String path)

Creates a new AggregateFunctionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
distinct:boolean: true to add DISTINCT to the query in order to have distinct values; false if it is not required
path:String: Either the identification variable or the state field path expression

Exceptions

NullPointerException:: The given parent cannot be null

AggregateFunctionStateObject back to summary

AggregateFunctionStateObject	back to summary
protected AggregateFunctionStateObject(StateObject parent, StateObject stateObject) Creates a new `AggregateStateObject`. 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 AggregateFunctionStateObject(StateObject parent, StateObject stateObject)

Creates a new AggregateStateObject.

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

AggregateFunctionStateObject back to summary

AggregateFunctionStateObject	back to summary
protected AggregateFunctionStateObject(StateObject parent, String path) Creates a new `AggregateFunctionStateObject`. Parameters parent:StateObject The parent of this state object, which cannot be `null` path:String Either the identification variable or the state field path expression Exceptions NullPointerException: The given parent cannot be `null`

protected AggregateFunctionStateObject(StateObject parent, String path)

Creates a new AggregateFunctionStateObject.

Parameters

parent:StateObject: The parent of this state object, which cannot be null
path:String: Either the identification variable or the state field path expression

Exceptions

NullPointerException:: The given parent cannot be null

Method Detail

getExpression back to summary

getExpression	back to summary
public AggregateFunction getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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:AggregateFunction 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 AggregateFunction getExpression()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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:AggregateFunction

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

hasDistinct back to summary

hasDistinct	back to summary
public boolean hasDistinct() Sets whether the `DISTINCT` keyword should be part of the query, which is used to return only distinct (different) values. Returns:boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required

public boolean hasDistinct()

Sets whether the DISTINCT keyword should be part of the query, which is used to return only distinct (different) values.

Returns:boolean: true to add DISTINCT to the query in order to have distinct values; false if it is not required

isEquivalent back to summary

isEquivalent	back to summary
public boolean isEquivalent(StateObject stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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.AbstractSingleEncapsulatedExpressionStateObject.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

setDistinct back to summary

setDistinct	back to summary
public void setDistinct(boolean distinct) Sets whether the `DISTINCT` keyword should be part of the query, which is used to return only distinct (different) values Parameters distinct:boolean `true` to add `DISTINCT` to the query in order to have distinct values; `false` if it is not required

public void setDistinct(boolean distinct)

Sets whether the DISTINCT keyword should be part of the query, which is used to return only distinct (different) values

Parameters

distinct:boolean: true to add DISTINCT to the query in order to have distinct values; false if it is not required

setStateObject back to summary

setStateObject	back to summary
public void setStateObject(StateObject stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.setStateObject. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.setStateObject. Sets the given `StateObject` to represent the new encapsulated expression. Parameters stateObject:StateObject The new encapsulated `StateObject` Annotations @Override

public void setStateObject(StateObject stateObject)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.setStateObject.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.setStateObject.

Sets the given StateObject to represent the new encapsulated expression.

Parameters

stateObject:StateObject: The new encapsulated StateObject

Annotations

@Override

toggleDistinct	back to summary
public void toggleDistinct() Reverses the visibility of the `DISTINCT` identifier.

toTextEncapsulatedExpression back to summary

toTextEncapsulatedExpression	back to summary
protected void toTextEncapsulatedExpression(Appendable writer) throws IOException Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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 AggregateFunctionStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail