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

Constructor Summary

Access	Constructor and Description
public	AvgFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent) Creates a new `AvgFunctionStateObject`.
public	AvgFunctionStateObject(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 `AvgFunctionStateObject`.
public	AvgFunctionStateObject(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 `AvgFunctionStateObject`.
public	AvgFunctionStateObject(StateObject The parent of this state object, which cannot be `null` parent, StateObject The `StateObject` representing the encapsulated expression stateObject) Creates a new `AvgFunctionStateObject`.
public	AvgFunctionStateObject(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 `AvgFunctionStateObject`.

Method Summary

Modifier and Type	Method and Description
public void	accept(StateObjectVisitor The `visitor` to visit this object visitor) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept. Visits this `StateObject` by the given `visitor`.
public AvgFunction	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AggregateFunctionStateObject.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 String	getIdentifier() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getIdentifier. Returns the JPQL identifier of the expression represented by this `AbstractSingleEncapsulatedExpressionStateObject`.
protected String	getQueryBNFId() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId. Returns the unique identifier of the `JPQLQueryBNF` that will determine how to parse the encapsulated expression.
public void	setExpression(AvgFunction The `parsed object` representing a `AVG` expression expression) Keeps a reference of the `parsed object` object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into `StateObjects`.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AggregateFunctionStateObject:: hasDistinct isEquivalent setDistinct setStateObject toggleDistinct toTextEncapsulatedExpression

Constructor Detail

AvgFunctionStateObject back to summary

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

public AvgFunctionStateObject(StateObject parent)

Creates a new AvgFunctionStateObject.

Parameters

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

Exceptions

NullPointerException:: The given parent cannot be null

AvgFunctionStateObject back to summary

AvgFunctionStateObject	back to summary
public AvgFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject) Creates a new `AvgFunctionStateObject`. 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`

public AvgFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject)

Creates a new AvgFunctionStateObject.

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

AvgFunctionStateObject back to summary

AvgFunctionStateObject	back to summary
public AvgFunctionStateObject(StateObject parent, boolean distinct, String path) Creates a new `AvgFunctionStateObject`. 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`

public AvgFunctionStateObject(StateObject parent, boolean distinct, String path)

Creates a new AvgFunctionStateObject.

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

AvgFunctionStateObject back to summary

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

public AvgFunctionStateObject(StateObject parent, StateObject stateObject)

Creates a new AvgFunctionStateObject.

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

AvgFunctionStateObject back to summary

AvgFunctionStateObject	back to summary
public AvgFunctionStateObject(StateObject parent, String path) Creates a new `AvgFunctionStateObject`. 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`

public AvgFunctionStateObject(StateObject parent, String path)

Creates a new AvgFunctionStateObject.

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

accept back to summary

accept	back to summary
public void accept(StateObjectVisitor visitor) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept. Visits this `StateObject` by the given `visitor`. Parameters visitor:StateObjectVisitor The `visitor` to visit this object Annotations @Override

public void accept(StateObjectVisitor visitor)

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

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

Visits this StateObject by the given visitor.

Parameters

visitor:StateObjectVisitor: The visitor to visit this object

Annotations

@Override

getExpression back to summary

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

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

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

getIdentifier back to summary

getIdentifier	back to summary
public String getIdentifier() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getIdentifier. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getIdentifier. Returns the JPQL identifier of the expression represented by this `AbstractSingleEncapsulatedExpressionStateObject`. Returns:String The JPQL identifier that is shown before the left parenthesis Annotations @Override

public String getIdentifier()

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

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

Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.

Returns:String

The JPQL identifier that is shown before the left parenthesis

Annotations

@Override

getQueryBNFId back to summary

getQueryBNFId	back to summary
protected String getQueryBNFId() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.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 Annotations @Override

protected String getQueryBNFId()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject.getQueryBNFId.

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

Annotations

@Override

setExpression back to summary

setExpression	back to summary
public void setExpression(AvgFunction expression) Keeps a reference of the `parsed object` object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into `StateObjects`. Parameters expression:AvgFunction The `parsed object` representing a `AVG` expression

public void setExpression(AvgFunction expression)

Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Parameters

expression:AvgFunction: The parsed object representing a AVG expression

public Class AvgFunctionStateObject

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail