java.lang.Object
- ca.uhn.fhir.rest.param.BaseParamWithPrefix<QuantityParam>
- - ca.uhn.fhir.rest.param.QuantityParam

All Implemented Interfaces:: IQueryParameterType, Serializable

public class QuantityParam
extends BaseParamWithPrefix<QuantityParam>
implements IQueryParameterType

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor	Description
`QuantityParam()`	Constructor
`QuantityParam(long theQuantity)`	Constructor
`QuantityParam(ParamPrefixEnum thePrefix, double theValue, String theSystem, String theUnits)`	Constructor
`QuantityParam(ParamPrefixEnum thePrefix, long theValue, String theSystem, String theUnits)`	Constructor
`QuantityParam(ParamPrefixEnum thePrefix, BigDecimal theValue, String theSystem, String theUnits)`	Constructor
`QuantityParam(String theQuantity)`	Constructor
`QuantityParam(String theQuantity, String theSystem, String theUnits)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`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").
`String`	`getSystem()`	Returns the system, or null if none was provided
`UriDt`	`getSystemAsUriDt()`	Deprecated. Use {`getSystem()`} instead
`String`	`getUnits()`
`BigDecimal`	`getValue()`	Returns the quantity/value, or null if none was provided
`String`	`getValueAsQueryToken(FhirContext theContext)`	Returns a representation of this parameter's value as it will be represented "over the wire".
`String`	`getValueAsString()`
`protected boolean`	`isSupportsChain()`	Does this parameter type support chained parameters (only reference should return `true` for this)
`ca.uhn.fhir.rest.param.BaseParam`	`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(IPrimitiveType<String> theSystem)`
`QuantityParam`	`setUnits(String theUnits)`
`QuantityParam`	`setValue(double theValue)`
`QuantityParam`	`setValue(long theValue)`
`QuantityParam`	`setValue(String theValue)`
`QuantityParam`	`setValue(BigDecimal theValue)`
`QuantityParam`	`setValue(IPrimitiveType<BigDecimal> theValue)`
`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.
`String`	`toString()`

Methods inherited from class ca.uhn.fhir.rest.param.BaseParamWithPrefix
getPrefix, setPrefix

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(ParamPrefixEnum thePrefix,
                     BigDecimal theValue,
                     String theSystem,
                     String theUnits)
```
    Constructor
    
    Parameters:
    
    thePrefix - The comparator, or null for an equals comparator
    
    theValue - A quantity value
    
    theSystem - The unit system
    
    theUnits - The unit code
  - QuantityParam
```
public QuantityParam(ParamPrefixEnum thePrefix,
                     double theValue,
                     String theSystem,
                     String theUnits)
```
    Constructor
    
    Parameters:
    
    thePrefix - The comparator, or null for an equals comparator
    
    theValue - A quantity value
    
    theSystem - The unit system
    
    theUnits - The unit code
  - QuantityParam
```
public QuantityParam(ParamPrefixEnum thePrefix,
                     long theValue,
                     String theSystem,
                     String theUnits)
```
    Constructor
    
    Parameters:
    
    thePrefix - 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 "gt4"
  - 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
  - getValueAsString
```
public String getValueAsString()
```
  - getSystem
```
public String getSystem()
```
    Returns the system, or null if none was provided
    Note that prior to HAPI FHIR 1.5, this method returned a UriDt
    
    Since:
    
    1.5
  - getSystemAsUriDt
```
@Deprecated
public UriDt getSystemAsUriDt()
```
    Deprecated.
    Use {getSystem()} instead
  - getUnits
```
public String getUnits()
```
  - getValue
```
public BigDecimal getValue()
```
    Returns the quantity/value, or null if none was provided
    Note that prior to HAPI FHIR 1.5, this method returned a DecimalDt
    
    Since:
    
    1.5
  - setSystem
```
public QuantityParam setSystem(String theSystem)
```
  - setSystem
```
public QuantityParam setSystem(IPrimitiveType<String> theSystem)
```
  - setUnits
```
public QuantityParam setUnits(String theUnits)
```
  - setValue
```
public QuantityParam setValue(BigDecimal theValue)
```
  - setValue
```
public QuantityParam setValue(IPrimitiveType<BigDecimal> theValue)
```
  - setValue
```
public QuantityParam setValue(String 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"). Returns null if none are present.
    
    Specified by:
    
    getQueryParameterQualifier in interface IQueryParameterType
  - getValueAsQueryToken
```
public final 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)
  - isSupportsChain
```
protected boolean isSupportsChain()
```
    Does this parameter type support chained parameters (only reference should return true for this)
  - setMissing
```
public ca.uhn.fhir.rest.param.BaseParam 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
    
    Returns:
    
    Returns a reference to this for easier method chaining
  - setValueAsQueryToken
```
public final 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"

Class QuantityParam

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.rest.param.BaseParamWithPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

QuantityParam

QuantityParam

QuantityParam

QuantityParam

QuantityParam

QuantityParam

QuantityParam

Method Detail

getValueAsString

getSystem

getSystemAsUriDt

getUnits

getValue

setSystem

setSystem

setUnits

setValue

setValue

setValue

setValue

setValue

toString

getMissing

getQueryParameterQualifier

getValueAsQueryToken

isSupportsChain

setMissing

setValueAsQueryToken