ca.uhn.fhir.model.dstu.composite.RatioDt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-android Show documentation
There is a newer version: 7.6.1
















package ca.uhn.fhir.model.dstu.composite;

import java.math.BigDecimal;
import org.apache.commons.lang3.StringUtils;
import java.util.*;
import ca.uhn.fhir.model.api.*;
import ca.uhn.fhir.model.primitive.*;
import ca.uhn.fhir.model.api.annotation.*;
import ca.uhn.fhir.model.base.composite.*;

import ca.uhn.fhir.model.dstu.valueset.AddressUseEnum;
import ca.uhn.fhir.model.dstu.composite.CodingDt;
import ca.uhn.fhir.model.dstu.valueset.ContactSystemEnum;
import ca.uhn.fhir.model.dstu.valueset.ContactUseEnum;
import ca.uhn.fhir.model.dstu.valueset.EventTimingEnum;
import ca.uhn.fhir.model.dstu.valueset.IdentifierUseEnum;
import ca.uhn.fhir.model.dstu.valueset.NameUseEnum;
import ca.uhn.fhir.model.dstu.resource.Organization;
import ca.uhn.fhir.model.dstu.composite.PeriodDt;
import ca.uhn.fhir.model.dstu.valueset.QuantityCompararatorEnum;
import ca.uhn.fhir.model.dstu.composite.QuantityDt;
import ca.uhn.fhir.model.api.TemporalPrecisionEnum;
import ca.uhn.fhir.model.dstu.valueset.UnitsOfTimeEnum;
import ca.uhn.fhir.model.dstu.resource.ValueSet;
import ca.uhn.fhir.model.dstu.composite.ResourceReferenceDt;
import ca.uhn.fhir.model.primitive.Base64BinaryDt;
import ca.uhn.fhir.model.primitive.BooleanDt;
import ca.uhn.fhir.model.primitive.BoundCodeDt;
import ca.uhn.fhir.model.primitive.CodeDt;
import ca.uhn.fhir.model.primitive.DateTimeDt;
import ca.uhn.fhir.model.primitive.DecimalDt;
import ca.uhn.fhir.model.primitive.IntegerDt;
import ca.uhn.fhir.model.primitive.StringDt;
import ca.uhn.fhir.model.primitive.UriDt;

/**
 * HAPI/FHIR RatioDt Datatype
 * (A ratio of two Quantity values - a numerator and a denominator)
 *
 * 
 * Definition:
 * A relationship of two Quantity values - expressed as a numerator and a denominator.
 *  
 *
 * 
 * Requirements:
 * Need to able to capture ratios for some measurements (titers) and some rates (costs)
 *  
 */
@DatatypeDef(name="RatioDt") 
public class RatioDt
        extends  BaseIdentifiableElement         implements ICompositeDatatype
{

	/**
	 * Constructor
	 */
	public RatioDt() {
		// nothing
	}


	@Child(name="numerator", type=QuantityDt.class, order=0, min=0, max=1, summary=true, modifier=false)	
	@Description(
		shortDefinition="Numerator value",
		formalDefinition="The value of the numerator"
	)
	private QuantityDt myNumerator;
	
	@Child(name="denominator", type=QuantityDt.class, order=1, min=0, max=1, summary=true, modifier=false)	
	@Description(
		shortDefinition="Denominator value",
		formalDefinition="The value of the denominator"
	)
	private QuantityDt myDenominator;
	

	@Override
	public boolean isEmpty() {
		return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty(  myNumerator,  myDenominator);
	}
	
	@Override
	public  List getAllPopulatedChildElementsOfType(Class theType) {
		return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myNumerator, myDenominator);
	}

	/**
	 * Gets the value(s) for numerator (Numerator value).
	 * creating it if it does
	 * not exist. Will not return null.
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public QuantityDt getNumerator() {  
		if (myNumerator == null) {
			myNumerator = new QuantityDt();
		}
		return myNumerator;
	}

	/**
	 * Gets the value(s) for numerator (Numerator value).
	 * creating it if it does
	 * not exist. Will not return null.
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public QuantityDt getNumeratorElement() {  
		if (myNumerator == null) {
			myNumerator = new QuantityDt();
		}
		return myNumerator;
	}


	/**
	 * Sets the value(s) for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator(QuantityDt theValue) {
		myNumerator = theValue;
		return this;
	}

 	/**
	 * Sets the value for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator( QuantityCompararatorEnum theComparator,  long theValue,  String theUnits) {
		myNumerator = new QuantityDt(theComparator, theValue, theUnits); 
		return this; 
	}

	/**
	 * Sets the value for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator( QuantityCompararatorEnum theComparator,  double theValue,  String theSystem,  String theUnits) {
		myNumerator = new QuantityDt(theComparator, theValue, theSystem, theUnits); 
		return this; 
	}

	/**
	 * Sets the value for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator( QuantityCompararatorEnum theComparator,  long theValue,  String theSystem,  String theUnits) {
		myNumerator = new QuantityDt(theComparator, theValue, theSystem, theUnits); 
		return this; 
	}

	/**
	 * Sets the value for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator( double theValue) {
		myNumerator = new QuantityDt(theValue); 
		return this; 
	}

	/**
	 * Sets the value for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator( long theValue) {
		myNumerator = new QuantityDt(theValue); 
		return this; 
	}

	/**
	 * Sets the value for numerator (Numerator value)
	 *
     * 
     * Definition:
     * The value of the numerator
     *  
	 */
	public RatioDt setNumerator( QuantityCompararatorEnum theComparator,  double theValue,  String theUnits) {
		myNumerator = new QuantityDt(theComparator, theValue, theUnits); 
		return this; 
	}

 
	/**
	 * Gets the value(s) for denominator (Denominator value).
	 * creating it if it does
	 * not exist. Will not return null.
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public QuantityDt getDenominator() {  
		if (myDenominator == null) {
			myDenominator = new QuantityDt();
		}
		return myDenominator;
	}

	/**
	 * Gets the value(s) for denominator (Denominator value).
	 * creating it if it does
	 * not exist. Will not return null.
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public QuantityDt getDenominatorElement() {  
		if (myDenominator == null) {
			myDenominator = new QuantityDt();
		}
		return myDenominator;
	}


	/**
	 * Sets the value(s) for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator(QuantityDt theValue) {
		myDenominator = theValue;
		return this;
	}

 	/**
	 * Sets the value for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator( QuantityCompararatorEnum theComparator,  long theValue,  String theUnits) {
		myDenominator = new QuantityDt(theComparator, theValue, theUnits); 
		return this; 
	}

	/**
	 * Sets the value for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator( QuantityCompararatorEnum theComparator,  double theValue,  String theSystem,  String theUnits) {
		myDenominator = new QuantityDt(theComparator, theValue, theSystem, theUnits); 
		return this; 
	}

	/**
	 * Sets the value for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator( QuantityCompararatorEnum theComparator,  long theValue,  String theSystem,  String theUnits) {
		myDenominator = new QuantityDt(theComparator, theValue, theSystem, theUnits); 
		return this; 
	}

	/**
	 * Sets the value for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator( double theValue) {
		myDenominator = new QuantityDt(theValue); 
		return this; 
	}

	/**
	 * Sets the value for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator( long theValue) {
		myDenominator = new QuantityDt(theValue); 
		return this; 
	}

	/**
	 * Sets the value for denominator (Denominator value)
	 *
     * 
     * Definition:
     * The value of the denominator
     *  
	 */
	public RatioDt setDenominator( QuantityCompararatorEnum theComparator,  double theValue,  String theUnits) {
		myDenominator = new QuantityDt(theComparator, theValue, theUnits); 
		return this; 
	}

 


}