org.hl7.elm.r1.ToQuantity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elm Show documentation
The elm library for the Clinical Quality Language Java reference implementation
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v3.0.2 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
// Generated on: 2024.12.20 at 10:51:29 AM MST 
//


package org.hl7.elm.r1;

import java.util.Collection;
import javax.xml.namespace.QName;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlType;
import org.hl7.cql_annotations.r1.CqlToElmBase;
import org.jvnet.jaxb2_commons.lang.Equals2;
import org.jvnet.jaxb2_commons.lang.EqualsStrategy2;
import org.jvnet.jaxb2_commons.lang.HashCode2;
import org.jvnet.jaxb2_commons.lang.HashCodeStrategy2;
import org.jvnet.jaxb2_commons.lang.JAXBEqualsStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBHashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBToStringStrategy;
import org.jvnet.jaxb2_commons.lang.ToString2;
import org.jvnet.jaxb2_commons.lang.ToStringStrategy2;
import org.jvnet.jaxb2_commons.locator.ObjectLocator;


/**
 * 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>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ToQuantity", namespace = "urn:hl7-org:elm:r1")
public class ToQuantity
    extends UnaryExpression
    implements Equals2, HashCode2, ToString2
{


    @Override
    public ToQuantity withOperand(Expression value) {
        setOperand(value);
        return this;
    }

    @Override
    public ToQuantity withSignature(TypeSpecifier... values) {
        if (values!= null) {
            for (TypeSpecifier value: values) {
                getSignature().add(value);
            }
        }
        return this;
    }

    @Override
    public ToQuantity withSignature(Collection values) {
        if (values!= null) {
            getSignature().addAll(values);
        }
        return this;
    }

    @Override
    public ToQuantity withAnnotation(CqlToElmBase... values) {
        if (values!= null) {
            for (CqlToElmBase value: values) {
                getAnnotation().add(value);
            }
        }
        return this;
    }

    @Override
    public ToQuantity withAnnotation(Collection values) {
        if (values!= null) {
            getAnnotation().addAll(values);
        }
        return this;
    }

    @Override
    public ToQuantity withResultTypeSpecifier(TypeSpecifier value) {
        setResultTypeSpecifier(value);
        return this;
    }

    @Override
    public ToQuantity withLocalId(String value) {
        setLocalId(value);
        return this;
    }

    @Override
    public ToQuantity withLocator(String value) {
        setLocator(value);
        return this;
    }

    @Override
    public ToQuantity withResultTypeName(QName value) {
        setResultTypeName(value);
        return this;
    }

    @Override
    public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator, Object object, EqualsStrategy2 strategy) {
        if ((object == null)||(this.getClass()!= object.getClass())) {
            return false;
        }
        if (this == object) {
            return true;
        }
        if (!super.equals(thisLocator, thatLocator, object, strategy)) {
            return false;
        }
        return true;
    }

    @Override
    public boolean equals(Object object) {
        final EqualsStrategy2 strategy = JAXBEqualsStrategy.getInstance();
        return equals(null, null, object, strategy);
    }

    @Override
    public int hashCode(ObjectLocator locator, HashCodeStrategy2 strategy) {
        int currentHashCode = super.hashCode(locator, strategy);
        return currentHashCode;
    }

    @Override
    public int hashCode() {
        final HashCodeStrategy2 strategy = JAXBHashCodeStrategy.getInstance();
        return this.hashCode(null, strategy);
    }

    @Override
    public String toString() {
        final ToStringStrategy2 strategy = JAXBToStringStrategy.getInstance();
        final StringBuilder buffer = new StringBuilder();
        append(null, buffer, strategy);
        return buffer.toString();
    }

    @Override
    public StringBuilder append(ObjectLocator locator, StringBuilder buffer, ToStringStrategy2 strategy) {
        strategy.appendStart(locator, this, buffer);
        appendFields(locator, buffer, strategy);
        strategy.appendEnd(locator, this, buffer);
        return buffer;
    }

    @Override
    public StringBuilder appendFields(ObjectLocator locator, StringBuilder buffer, ToStringStrategy2 strategy) {
        super.appendFields(locator, buffer, strategy);
        return buffer;
    }

}