ca.uhn.fhir.model.base.composite

Class BaseQuantityDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.base.composite.BaseQuantityDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, ICompositeType

public abstract class BaseQuantityDt
extends BaseIdentifiableElement
implements ICompositeDatatype, IQueryParameterType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseQuantityDt()

Method Summary

Modifier and Type	Method and Description
abstract CodeDt	getCodeElement() Gets the value(s) for code (Coded form of the unit).
abstract BoundCodeDt<?>	getComparatorElement() Gets the value(s) for comparator (< | <= | >= | > - how to understand the value).
Boolean	getMissing() Deprecated. get/setMissing is not supported in StringDt. Use QuantityParam instead if you need this functionality
String	getQueryParameterQualifier() This method will return any qualifier that should be appended to the parameter name (e.g ":exact")
abstract UriDt	getSystemElement() Gets the value(s) for system (System that defines coded unit form).
abstract StringDt	getUnitsElement() Gets the value(s) for units (Unit representation).
String	getValueAsQueryToken(FhirContext theContext) Returns a representation of this parameter's value as it will be represented "over the wire".
abstract DecimalDt	getValueElement() Gets the value(s) for value (Numerical value (with implicit precision)).
abstract BaseQuantityDt	setCode(String theCode) Sets the value for code (Coded form of the unit)
IQueryParameterType	setMissing(Boolean theMissing) Deprecated. get/setMissing is not supported in StringDt. Use QuantityParam instead if you need this functionality
abstract BaseQuantityDt	setSystem(String theUri) Sets the value for system (System that defines coded unit form)
abstract BaseQuantityDt	setUnits(String theString) Sets the value for units (Unit representation)
abstract BaseQuantityDt	setValue(BigDecimal theValue) Sets the value(s) for value (Numerical value (with implicit precision))
void	setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theValue) This method is generally only called by HAPI itself, and should not need to be called from user code.

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.ICompositeElement

getAllPopulatedChildElementsOfType

Constructor Detail

BaseQuantityDt

public BaseQuantityDt()

Method Detail

setValue

public abstract BaseQuantityDt setValue(BigDecimal theValue)

Sets the value(s) for value (Numerical value (with implicit precision))

Definition: The value of the measured amount. The value includes an implicit precision in the presentation of the value

setValueAsQueryToken

public void setValueAsQueryToken(FhirContext theContext,
                                 String theParamName,
                                 String theQualifier,
                                 String theValue)

Description copied from interface: IQueryParameterType

This method is generally only called by HAPI itself, and should not need to be called from user code.

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

setValueAsQueryToken in interface IQueryParameterType

Parameters:

theContext - TODO

theParamName - TODO

theQualifier - The parameter name qualifier that accompanied this value. For example, if the complete query was http://foo?name:exact=John, qualifier would be ":exact"

theValue - The actual parameter value. For example, if the complete query was http://foo?name:exact=John, the value would be "John"

getComparatorElement

public abstract BoundCodeDt<?> getComparatorElement()

Gets the value(s) for comparator (< | <= | >= | > - how to understand the value). creating it if it does not exist. Will not return null.

Definition: How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is \"<\" , then the real value is < stated value

getValueAsQueryToken

public String getValueAsQueryToken(FhirContext theContext)

Description copied from interface: IQueryParameterType

Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

getValueAsQueryToken in interface IQueryParameterType

Parameters:

theContext - TODO

Returns:

Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

getQueryParameterQualifier

public String getQueryParameterQualifier()

Description copied from interface: IQueryParameterType

This method will return any qualifier that should be appended to the parameter name (e.g ":exact")

Specified by:

getQueryParameterQualifier in interface IQueryParameterType

setUnits

public abstract BaseQuantityDt setUnits(String theString)

Sets the value for units (Unit representation)

Definition: A human-readable form of the units

getSystemElement

public abstract UriDt getSystemElement()

Gets the value(s) for system (System that defines coded unit form). creating it if it does not exist. Will not return null.

Definition: The identification of the system that provides the coded form of the unit

setSystem

public abstract BaseQuantityDt setSystem(String theUri)

Sets the value for system (System that defines coded unit form)

Definition: The identification of the system that provides the coded form of the unit

getCodeElement

public abstract CodeDt getCodeElement()

Gets the value(s) for code (Coded form of the unit). creating it if it does not exist. Will not return null.

Definition: A computer processable form of the units in some unit representation system

setCode

public abstract BaseQuantityDt setCode(String theCode)

Sets the value for code (Coded form of the unit)

Definition: A computer processable form of the units in some unit representation system

getUnitsElement

public abstract StringDt getUnitsElement()

Gets the value(s) for units (Unit representation). creating it if it does not exist. Will not return null.

Definition: A human-readable form of the units

getValueElement

public abstract DecimalDt getValueElement()

Gets the value(s) for value (Numerical value (with implicit precision)). creating it if it does not exist. Will not return null.

Definition: The value of the measured amount. The value includes an implicit precision in the presentation of the value

getMissing

@Deprecated
public Boolean getMissing()

Deprecated. get/setMissing is not supported in StringDt. Use QuantityParam instead if you need this functionality

Not supported!

Specified by:

getMissing in interface IQueryParameterType

setMissing

@Deprecated
public IQueryParameterType setMissing(Boolean theMissing)

Deprecated. get/setMissing is not supported in StringDt. Use QuantityParam instead if you need this functionality

Not supported!

Specified by:

setMissing in interface IQueryParameterType

Returns:

Returns a reference to this for easier method chaining