Package org.cqframework.cql.elm.execution

Class ToQuantity

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.OperatorExpression
org.cqframework.cql.elm.execution.UnaryExpression
org.cqframework.cql.elm.execution.ToQuantity
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
Direct Known Subclasses:
ToQuantityEvaluator
public class ToQuantity extends UnaryExpression implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
The ToQuantity operator converts the value of its argument to a Quantity value. The operator may be used with Integer, Decimal, Ratio, or String values. The operation does not perform any unit conversion, that capability is supported by the ConvertQuantity operator. For String values, the operator accepts strings using the following format: (+|-)?#0(.0#)?('')? Meaning an optional polarity indicator, followed by any number of digits (including none) followed by at least one digit, optionally followed by a decimal point, at least one digit, and any number of additional digits, all optionally followed by a unit designator as a string literal specifying a valid UCUM unit of measure or calendar duration keyword, singular or plural. Spaces are allowed between the quantity value and the unit designator. See the Formatting Strings topic in the CQL Reference (Appendix B) of the CQL Specification for a description of formatting strings. Note that the decimal value of the quantity returned by this operator must be a valid value in the range representable for Decimal values in CQL. If the input string is not formatted correctly, or cannot be interpreted as a valid Quantity value, the result is null. For Integer and Decimal values, the result is a Quantity with the value of the integer or decimal input, and the default unit ('1'). For Ratio values, the operation is equivalent to the result of dividing the numerator of the ratio by the denominator. If the argument is null, the result is null.

Java class for ToQuantity complex type.

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

 <complexType name="ToQuantity">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}UnaryExpression">
     </extension>
   </complexContent>
 </complexType>