Package org.cqframework.cql.elm.execution

Class Equivalent

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.BinaryExpression
org.cqframework.cql.elm.execution.Equivalent
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
Direct Known Subclasses:
EquivalentEvaluator
public class Equivalent extends BinaryExpression implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
The Equivalent operator returns true if the arguments are the same value, or if they are both null; and false otherwise. With the exception of null behavior and the semantics for specific types defined below, equivalence is the same as equality. For string values, equivalence returns true if the strings are the same value while ignoring case and locale, and normalizing whitespace. Normalizing whitespace means that all whitespace characters are treated as equivalent, with whitespace characters as defined in the whitespace lexical category. For decimals, equivalent means the values are the same with the comparison done on values rounded to the least precision of the least precise operand; trailing zeroes after the decimal are ignored in determining precision for equivalent comparison. For quantities, equivalent means the values are the same quantity when considering unit conversion (e.g. 100 'cm' ~ 1 'm') and using decimal equivalent semantics for the value. Note that implementations are not required to support unit conversion and so are allowed to return false for equivalence of quantities with different units. For time-valued quantities, UCUM definite-time duration quantities above days (and weeks) are considered equivalent to their calendar duration counterparts. Definite-time duration unit conversions shall be performed as specified in ISO-8601, while calendar-time duration unit conversions shall be performed according to the calendar duration semantics. In particular, unit conversion between variable length calendar durations (i.e. years and months) and definite-time durations (i.e. days or below) uses the approximations of 365 days in a year, and 30 days in a month. For ratios, equivalent means that the numerator and denominator represent the same ratio (e.g. 1:100 ~ 10:1000). For tuple types, this means that two tuple values are equivalent if and only if the tuples are of the same type, and the values for all elements by name are equivalent. For list types, this means that two lists are equivalent if and only if the lists contain elements of the same type, have the same number of elements, and for each element in the lists, in order, the elements are equivalent. For interval types, this means that two intervals are equivalent if and only if the intervals are over the same point type, and the starting and ending points of the intervals as determined by the Start and End operators are equivalent. For Date, Time, and DateTime values, the comparison is performed in the same way as it is for equality, except that if one input has a value for a given precision and the other does not, the comparison stops and the result is false, rather than null. As with equality, the second and millisecond precisions are combined as a single precision using a decimal, with decimal equivalence semantics. For Code values, equivalence is defined based on the code and system elements only. The display and version elements are ignored for the purposes of determining Code equivalence. For Concept values, equivalence is defined as a non-empty intersection of the codes in each Concept. Note that this operator will always return true or false, even if either or both of its arguments are null or contain null components.

Java class for Equivalent complex type.

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

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