Package org.cqframework.cql.elm.execution

Class AggregateExpression

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Aggregate, AllTrue, AnyTrue, Avg, Count, GeometricMean, Max, Median, Min, Mode, PopulationStdDev, PopulationVariance, Product, StdDev, Sum, Variance

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

Aggregate expressions perform operations on lists of data, either directly on a list of scalars, or indirectly on a list of objects, with a reference to a property present on each object in the list. Aggregate expressions deal with missing information by excluding missing values from consideration before performing the aggregated operation. For example, in a Sum over Dose, any instance of Medication with no value for Dose would be ignored. An aggregate operation performed over an empty list is defined to return null, except as noted in the documentation for each operator (Count, AllTrue, and AnyTrue are the exceptions).

Java class for AggregateExpression complex type.

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

 <complexType name="AggregateExpression">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}Expression">
       <sequence>
         <element name="signature" type="{urn:hl7-org:elm:r1}TypeSpecifier" maxOccurs="unbounded" minOccurs="0"/>
         <element name="source" type="{urn:hl7-org:elm:r1}Expression"/>
       </sequence>
       <attribute name="path" type="{http://www.w3.org/2001/XMLSchema}string" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	path
protected List<TypeSpecifier>	signature
protected Expression	source

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

annotation, localId, locator, resultTypeName, resultTypeSpecifier

Constructor Summary

Constructors

Constructor	Description
AggregateExpression()

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)
String	getPath()	Gets the value of the path property.
List<TypeSpecifier>	getSignature()	Gets the value of the signature property.
Expression	getSource()	Gets the value of the source property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
void	setPath(String value)	Sets the value of the path property.
void	setSource(Expression value)	Sets the value of the source property.
String	toString()
AggregateExpression	withAnnotation(Collection<CqlToElmBase> values)
AggregateExpression	withAnnotation(CqlToElmBase... values)
AggregateExpression	withLocalId(String value)
AggregateExpression	withLocator(String value)
AggregateExpression	withPath(String value)
AggregateExpression	withResultTypeName(QName value)
AggregateExpression	withResultTypeSpecifier(TypeSpecifier value)
AggregateExpression	withSignature(Collection<TypeSpecifier> values)
AggregateExpression	withSignature(TypeSpecifier... values)
AggregateExpression	withSource(Expression value)

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

signature

protected List<TypeSpecifier> signature

source

protected Expression source

path

protected String path

Constructor Details

AggregateExpression

public AggregateExpression()

Method Details

getSignature

public List<TypeSpecifier> getSignature()

Gets the value of the signature property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the signature property.

For example, to add a new item, do as follows:

    getSignature().add(newItem);
 

Objects of the following type(s) are allowed in the list TypeSpecifier

getSource

public Expression getSource()

Gets the value of the source property.

Returns:

possible object is Expression

setSource

public void setSource(Expression value)

Sets the value of the source property.

Parameters:

value - allowed object is Expression

getPath

public String getPath()

Gets the value of the path property.

Returns:

possible object is String

setPath

public void setPath(String value)

Sets the value of the path property.

Parameters:

value - allowed object is String

withSignature

public AggregateExpression withSignature(TypeSpecifier... values)

withSignature

public AggregateExpression withSignature(Collection<TypeSpecifier> values)

withSource

public AggregateExpression withSource(Expression value)

withPath

public AggregateExpression withPath(String value)

withAnnotation

public AggregateExpression withAnnotation(CqlToElmBase... values)

Overrides:

withAnnotation in class Expression

withAnnotation

public AggregateExpression withAnnotation(Collection<CqlToElmBase> values)

Overrides:

withAnnotation in class Expression

withResultTypeSpecifier

public AggregateExpression withResultTypeSpecifier(TypeSpecifier value)

Overrides:

withResultTypeSpecifier in class Expression

withLocalId

public AggregateExpression withLocalId(String value)

Overrides:

withLocalId in class Expression

withLocator

public AggregateExpression withLocator(String value)

Overrides:

withLocator in class Expression

withResultTypeName

public AggregateExpression withResultTypeName(QName value)

Overrides:

withResultTypeName in class Expression

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 Expression

equals

public boolean equals(Object object)

Overrides:

equals in class Expression

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 Expression

hashCode

public int hashCode()

Overrides:

hashCode in class Expression

toString

public String toString()

Overrides:

toString in class Expression

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 Expression

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 Expression