Class AvgFunctionStateObject
- 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.AbstractSingleEncapsulatedExpressionStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AggregateFunctionStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AvgFunctionStateObject
-
- All Implemented Interfaces:
StateObject
public class AvgFunctionStateObject extends AggregateFunctionStateObject
One of the aggregate functions. The arguments must be numeric.AVG
returnsDouble
.BNF:expression ::= AVG([DISTINCT] state_field_path_expression)
- Since:
- 2.4
- Version:
- 2.4
- Author:
- Pascal Filion
- See Also:
AvgFunction
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AggregateFunctionStateObject
DISTINCT_PROPERTY
-
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
STATE_OBJECT_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description AvgFunctionStateObject(StateObject parent)
Creates a newAvgFunctionStateObject
.AvgFunctionStateObject(StateObject parent, boolean distinct, java.lang.String path)
Creates a newAvgFunctionStateObject
.AvgFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject)
Creates a newAvgFunctionStateObject
.AvgFunctionStateObject(StateObject parent, java.lang.String path)
Creates a newAvgFunctionStateObject
.AvgFunctionStateObject(StateObject parent, StateObject stateObject)
Creates a newAvgFunctionStateObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.AvgFunction
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.java.lang.String
getIdentifier()
Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject
.void
setExpression(AvgFunction expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AggregateFunctionStateObject
hasDistinct, isEquivalent, setDistinct, setStateObject, toggleDistinct
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
getStateObject, hasStateObject, parse
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText
-
-
-
-
Constructor Detail
-
AvgFunctionStateObject
public AvgFunctionStateObject(StateObject parent)
Creates a newAvgFunctionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
AvgFunctionStateObject
public AvgFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject)
Creates a newAvgFunctionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
distinct
-true
to addDISTINCT
to the query in order to have distinct values;false
if it is not requiredstateObject
- TheStateObject
representing the encapsulated expression- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
AvgFunctionStateObject
public AvgFunctionStateObject(StateObject parent, boolean distinct, java.lang.String path)
Creates a newAvgFunctionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
distinct
-true
to addDISTINCT
to the query in order to have distinct values;false
if it is not requiredpath
- Either the identification variable or the state field path expression- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
AvgFunctionStateObject
public AvgFunctionStateObject(StateObject parent, StateObject stateObject)
Creates a newAvgFunctionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stateObject
- TheStateObject
representing the encapsulated expression- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
AvgFunctionStateObject
public AvgFunctionStateObject(StateObject parent, java.lang.String path)
Creates a newAvgFunctionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
path
- Either the identification variable or the state field path expression- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
getExpression
public AvgFunction getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAggregateFunctionStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
getIdentifier
public java.lang.String getIdentifier()
Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject
.- Specified by:
getIdentifier
in classAbstractEncapsulatedExpressionStateObject
- Returns:
- The JPQL identifier that is shown before the left parenthesis
-
setExpression
public void setExpression(AvgFunction expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.- Parameters:
expression
- Theparsed object
representing aAVG
expression
-
-