Package org.cqframework.cql.elm.execution

Class Aggregate

java.lang.Object

org.opencds.cqf.cql.engine.elm.execution.Executable

org.cqframework.cql.elm.execution.Element

org.cqframework.cql.elm.execution.Expression

org.cqframework.cql.elm.execution.AggregateExpression

org.cqframework.cql.elm.execution.Aggregate

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

public class Aggregate
extends AggregateExpression
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

The Aggregate operator performs custom aggregation by evaluating an expression for each element of the source. If a path is specified, the aggregation is performed for value of the property specified by the path for each element of the source. The iteration expression has access to the $this, $index, and $total variables. At the end of each iteration, the value of the $total variable is updated to the result of the iteration expression. The value of the $total variable is initialized to the result of the initialValue expression, if present. If the list is null, the result is null.

Java class for Aggregate complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Aggregate">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}AggregateExpression">
       <sequence>
         <element name="iteration" type="{urn:hl7-org:elm:r1}Expression"/>
         <element name="initialValue" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression	initialValue
protected Expression	iteration

Fields inherited from class org.cqframework.cql.elm.execution.AggregateExpression

path, signature, source

Fields inherited from class org.cqframework.cql.elm.execution.Element

annotation, localId, locator, resultTypeName, resultTypeSpecifier

Constructor Summary

Constructors

Constructor	Description
Aggregate()

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
boolean	equals(Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
Expression	getInitialValue()	Gets the value of the initialValue property.
Expression	getIteration()	Gets the value of the iteration property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
void	setInitialValue(Expression value)	Sets the value of the initialValue property.
void	setIteration(Expression value)	Sets the value of the iteration property.
String	toString()
Aggregate	withAnnotation(Collection<CqlToElmBase> values)
Aggregate	withAnnotation(CqlToElmBase... values)
Aggregate	withInitialValue(Expression value)
Aggregate	withIteration(Expression value)
Aggregate	withLocalId(String value)
Aggregate	withLocator(String value)
Aggregate	withPath(String value)
Aggregate	withResultTypeName(QName value)
Aggregate	withResultTypeSpecifier(TypeSpecifier value)
Aggregate	withSignature(Collection<TypeSpecifier> values)
Aggregate	withSignature(TypeSpecifier... values)
Aggregate	withSource(Expression value)

Methods inherited from class org.cqframework.cql.elm.execution.AggregateExpression

getPath, getSignature, getSource, setPath, setSource

Methods inherited from class org.cqframework.cql.elm.execution.Element

getAnnotation, getLocalId, getLocator, getResultTypeName, getResultTypeSpecifier, setLocalId, setLocator, setResultTypeName, setResultTypeSpecifier

Methods inherited from class org.opencds.cqf.cql.engine.elm.execution.Executable

evaluate, internalEvaluate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

iteration

protected Expression iteration

initialValue

protected Expression initialValue

Constructor Details

Aggregate

public Aggregate()

Method Details

getIteration

public Expression getIteration()

Gets the value of the iteration property.

Returns:

possible object is Expression

setIteration

public void setIteration(Expression value)

Sets the value of the iteration property.

Parameters:

value - allowed object is Expression

getInitialValue

public Expression getInitialValue()

Gets the value of the initialValue property.

Returns:

possible object is Expression

setInitialValue

public void setInitialValue(Expression value)

Sets the value of the initialValue property.

Parameters:

value - allowed object is Expression

withIteration

public Aggregate withIteration(Expression value)

withInitialValue

public Aggregate withInitialValue(Expression value)

withSignature

public Aggregate withSignature(TypeSpecifier... values)

Overrides:

withSignature in class AggregateExpression

withSignature

public Aggregate withSignature(Collection<TypeSpecifier> values)

Overrides:

withSignature in class AggregateExpression

withSource

public Aggregate withSource(Expression value)

Overrides:

withSource in class AggregateExpression

withPath

public Aggregate withPath(String value)

Overrides:

withPath in class AggregateExpression

withAnnotation

public Aggregate withAnnotation(CqlToElmBase... values)

Overrides:

withAnnotation in class AggregateExpression

withAnnotation

public Aggregate withAnnotation(Collection<CqlToElmBase> values)

Overrides:

withAnnotation in class AggregateExpression

withResultTypeSpecifier

public Aggregate withResultTypeSpecifier(TypeSpecifier value)

Overrides:

withResultTypeSpecifier in class AggregateExpression

withLocalId

public Aggregate withLocalId(String value)

Overrides:

withLocalId in class AggregateExpression

withLocator

public Aggregate withLocator(String value)

Overrides:

withLocator in class AggregateExpression

withResultTypeName

public Aggregate withResultTypeName(QName value)

Overrides:

withResultTypeName in class AggregateExpression

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
 org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
 Object object,
 org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals2

Overrides:

equals in class AggregateExpression

equals

public boolean equals(Object object)

Overrides:

equals in class AggregateExpression

hashCode

public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)

Specified by:

hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2

Overrides:

hashCode in class AggregateExpression

hashCode

public int hashCode()

Overrides:

hashCode in class AggregateExpression

toString

public String toString()

Overrides:

toString in class AggregateExpression

append

public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

append in class AggregateExpression

appendFields

public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

appendFields in class AggregateExpression