Class SumFunctionStateObject
- 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.SumFunctionStateObject
-
- All Implemented Interfaces:
StateObject
public class SumFunctionStateObject extends AggregateFunctionStateObject
One of the aggregate functions. The arguments must be numeric.SUMreturnsLongwhen applied to state-fields of integral types (other thanBigInteger);Doublewhen applied to state-fields of floating point types;BigIntegerwhen applied to state-fields of typeBigInteger; andBigDecimalwhen applied to state-fields of typeBigDecimal. IfSUM,AVG,MAX, orMINis used, and there are no values to which the aggregate function can be applied, the result of the aggregate function isnull. IfCOUNTis used, and there are no values to whichCOUNTcan be applied, the result of the aggregate function is 0.BNF:expression ::= SUM([DISTINCT] state_field_path_expression)- Version:
- 2.4
- See Also:
SumFunction- Author:
- Pascal Filion
- Since:
- 2.4
-
-
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 SumFunctionStateObject(StateObject parent)Creates a newSumFunctionStateObject.SumFunctionStateObject(StateObject parent, boolean distinct, java.lang.String path)Creates a newSumFunctionStateObject.SumFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject)Creates a newSumFunctionStateObject.SumFunctionStateObject(StateObject parent, java.lang.String path)Creates a newSumFunctionStateObject.SumFunctionStateObject(StateObject parent, StateObject stateObject)Creates a newSumFunctionStateObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StateObjectVisitor visitor)Visits thisStateObjectby the givenvisitor.SumFunctiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.java.lang.StringgetIdentifier()Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject.protected java.lang.StringgetQueryBNFId()Returns the unique identifier of theJPQLQueryBNFthat will determine how to parse the encapsulated expression.voidsetExpression(SumFunction expression)Keeps a reference of theparsed objectobject, 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, toTextEncapsulatedExpression
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
addChildren, getStateObject, hasStateObject, parse
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject
toTextInternal
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, initialize, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText
-
-
-
-
Constructor Detail
-
SumFunctionStateObject
public SumFunctionStateObject(StateObject parent)
Creates a newSumFunctionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
SumFunctionStateObject
public SumFunctionStateObject(StateObject parent, boolean distinct, StateObject stateObject)
Creates a newSumFunctionStateObject.- Parameters:
parent- The parent of this state object, which cannot benulldistinct-trueto addDISTINCTto the query in order to have distinct values;falseif it is not requiredstateObject- TheStateObjectrepresenting the encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
SumFunctionStateObject
public SumFunctionStateObject(StateObject parent, boolean distinct, java.lang.String path)
Creates a newSumFunctionStateObject.- Parameters:
parent- The parent of this state object, which cannot benulldistinct-trueto addDISTINCTto the query in order to have distinct values;falseif it is not requiredpath- Either the identification variable or the state field path expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
SumFunctionStateObject
public SumFunctionStateObject(StateObject parent, StateObject stateObject)
Creates a newSumFunctionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullstateObject- TheStateObjectrepresenting the encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
SumFunctionStateObject
public SumFunctionStateObject(StateObject parent, java.lang.String path)
Creates a newSumFunctionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullpath- 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 thisStateObjectby the givenvisitor.- Parameters:
visitor- Thevisitorto visit this object
-
getExpression
public SumFunction getExpression()
Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpressionin interfaceStateObject- Overrides:
getExpressionin classAggregateFunctionStateObject- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObjectornullwhen 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:
getIdentifierin classAbstractEncapsulatedExpressionStateObject- Returns:
- The JPQL identifier that is shown before the left parenthesis
-
getQueryBNFId
protected java.lang.String getQueryBNFId()
Returns the unique identifier of theJPQLQueryBNFthat will determine how to parse the encapsulated expression.- Specified by:
getQueryBNFIdin classAbstractSingleEncapsulatedExpressionStateObject- Returns:
- The non-
nullID of the BNF
-
setExpression
public void setExpression(SumFunction expression)
Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.- Parameters:
expression- Theparsed objectrepresenting aSUMexpression
-
-