ca.uhn.fhir.rest.param

Class QuantityParam

java.lang.Object

ca.uhn.fhir.rest.param.QuantityParam

All Implemented Interfaces:

IQueryParameterType

public class QuantityParam
extends Object
implements IQueryParameterType

Constructor Summary

Constructors

Constructor and Description
QuantityParam() Constructor
QuantityParam(long theQuantity) Constructor
QuantityParam(QuantityCompararatorEnum theComparator, BigDecimal theValue, String theSystem, String theUnits) Constructor
QuantityParam(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Constructor
QuantityParam(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Constructor
QuantityParam(String theQuantity) Constructor
QuantityParam(String theQuantity, String theSystem, String theUnits) Constructor

Method Summary

Modifier and Type	Method and Description
QuantityCompararatorEnum	getComparator()
Boolean	getMissing() If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value
String	getQueryParameterQualifier() This method will return any qualifier that should be appended to the parameter name (e.g ":exact")
UriDt	getSystem()
String	getUnits()
DecimalDt	getValue()
String	getValueAsQueryToken() Returns a representation of this parameter's value as it will be represented "over the wire".
boolean	isApproximate()
void	setApproximate(boolean theApproximate)
QuantityParam	setComparator(QuantityCompararatorEnum theComparator)
QuantityParam	setComparator(String theComparator)
void	setMissing(Boolean theMissing) If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value
QuantityParam	setSystem(String theSystem)
QuantityParam	setSystem(UriDt theSystem)
QuantityParam	setUnits(String theUnits)
QuantityParam	setValue(BigDecimal theValue)
QuantityParam	setValue(DecimalDt theValue)
QuantityParam	setValue(double theValue)
QuantityParam	setValue(long theValue)
void	setValueAsQueryToken(String theQualifier, String theValue) This method is generally only called by HAPI itself, and should not need to be called from user code.
String	toString()

Methods inherited from class java.lang.Object

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

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

getMissing, getQueryParameterQualifier, getValueAsQueryToken, setMissing, setValueAsQueryToken

Constructor Detail

QuantityParam

public QuantityParam()

Constructor

QuantityParam

public QuantityParam(QuantityCompararatorEnum theComparator,
                     BigDecimal theValue,
                     String theSystem,
                     String theUnits)

Constructor

Parameters:

theComparator - The comparator, or null for an equals comparator

theValue - A quantity value

theSystem - The unit system

theUnits - The unit code

QuantityParam

public QuantityParam(QuantityCompararatorEnum theComparator,
                     double theValue,
                     String theSystem,
                     String theUnits)

Constructor

Parameters:

theComparator - The comparator, or null for an equals comparator

theValue - A quantity value

theSystem - The unit system

theUnits - The unit code

QuantityParam

public QuantityParam(QuantityCompararatorEnum theComparator,
                     long theValue,
                     String theSystem,
                     String theUnits)

Constructor

Parameters:

theComparator - The comparator, or null for an equals comparator

theValue - A quantity value

theSystem - The unit system

theUnits - The unit code

QuantityParam

public QuantityParam(String theQuantity)

Constructor

Parameters:

theQuantity - A quantity value (with no system or units), such as "100.0" or "<=4"

QuantityParam

public QuantityParam(long theQuantity)

Constructor

Parameters:

theQuantity - A quantity value (with no system or units), such as 100

QuantityParam

public QuantityParam(String theQuantity,
                     String theSystem,
                     String theUnits)

Constructor

Parameters:

theQuantity - A quantity value (with no system or units), such as "100.0" or "<=4"

theSystem - The unit system

theUnits - The unit code

Method Detail

getComparator

public QuantityCompararatorEnum getComparator()

getSystem

public UriDt getSystem()

getUnits

public String getUnits()

getValue

public DecimalDt getValue()

isApproximate

public boolean isApproximate()

setApproximate

public void setApproximate(boolean theApproximate)

setComparator

public QuantityParam setComparator(QuantityCompararatorEnum theComparator)

setComparator

public QuantityParam setComparator(String theComparator)

setSystem

public QuantityParam setSystem(String theSystem)

setSystem

public QuantityParam setSystem(UriDt theSystem)

setUnits

public QuantityParam setUnits(String theUnits)

setValue

public QuantityParam setValue(BigDecimal theValue)

setValue

public QuantityParam setValue(DecimalDt theValue)

setValue

public QuantityParam setValue(double theValue)

setValue

public QuantityParam setValue(long theValue)

toString

public String toString()

Overrides:

toString in class Object

getMissing

public Boolean getMissing()

If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value

Specified by:

getMissing in interface IQueryParameterType

getQueryParameterQualifier

public final 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

getValueAsQueryToken

public final String getValueAsQueryToken()

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

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)

setMissing

public void setMissing(Boolean theMissing)

If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value

Specified by:

setMissing in interface IQueryParameterType

setValueAsQueryToken

public final void setValueAsQueryToken(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:

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"