Package ca.uhn.fhir.rest.param

Class UriParam

java.lang.Object

ca.uhn.fhir.rest.param.UriParam

All Implemented Interfaces:

IQueryParameterType, Serializable

public class UriParam
extends Object
implements IQueryParameterType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UriParam()	Constructor
UriParam(String theValue)

Method Summary

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
UriParamQualifierEnum	getQualifier()	Gets the qualifier for this param (may be null and generally will be)
String	getQueryParameterQualifier()	This method will return any qualifier that should be appended to the parameter name (e.g ":exact").
String	getValue()
String	getValueAsQueryToken(FhirContext theContext)	Returns a representation of this parameter's value as it will be represented "over the wire".
StringDt	getValueAsStringDt()
UriDt	getValueAsUriDt()
String	getValueNotNull()
boolean	isEmpty()
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
UriParam	setQualifier(UriParamQualifierEnum theQualifier)	Sets the qualifier for this param (may be null and generally will be)
UriParam	setValue(String theValue)	Sets the value for this param
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 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

UriParam

public UriParam()

Constructor

UriParam

public UriParam(String theValue)

Method Detail

getQualifier

public UriParamQualifierEnum getQualifier()

Gets the qualifier for this param (may be null and generally will be)

getValue

public String getValue()

getValueAsStringDt

public StringDt getValueAsStringDt()

getValueAsUriDt

public UriDt getValueAsUriDt()

getValueNotNull

public String getValueNotNull()

isEmpty

public boolean isEmpty()

setQualifier

public UriParam setQualifier(UriParamQualifierEnum theQualifier)

Sets the qualifier for this param (may be null and generally will be)

Returns:

Returns a reference to this for easy method chanining

setValue

public UriParam setValue(String theValue)

Sets the value for this param

Returns:

Returns a reference to this for easy method chanining

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"