ca.uhn.fhir.rest.param

Class TokenParam

java.lang.Object

ca.uhn.fhir.rest.param.TokenParam

All Implemented Interfaces:

IQueryParameterType

public class TokenParam
extends Object
implements IQueryParameterType

Constructor Summary

Constructors

Constructor and Description
TokenParam() Constructor
TokenParam(BaseCodingDt theCodingDt) Constructor which copies the system and code from a InternalCodingDt instance and adds it as a parameter
TokenParam(BaseIdentifierDt theIdentifierDt) Constructor which copies the system and value from a BaseIdentifierDt instance and adds it as a parameter
TokenParam(String theSystem, String theValue)
TokenParam(String theSystem, String theValue, boolean theText)

Method Summary

Modifier and Type	Method and 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
TokenParamModifier	getModifier() Returns the modifier for this token
String	getQueryParameterQualifier() This method will return any qualifier that should be appended to the parameter name (e.g ":exact")
String	getSystem() Returns the system for this token.
String	getValue() Returns the value for the token
InternalCodingDt	getValueAsCoding()
String	getValueAsQueryToken() Returns a representation of this parameter's value as it will be represented "over the wire".
String	getValueNotNull()
boolean	isEmpty()
boolean	isText() Returns true if getModifier() returns TokenParamModifier.TEXT
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
TokenParam	setModifier(TokenParamModifier theModifier)
TokenParam	setSystem(String theSystem)
TokenParam	setText(boolean theText) Deprecated. Use setModifier(TokenParamModifier) instead
TokenParam	setValue(String 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

TokenParam

public TokenParam()

Constructor

TokenParam

public TokenParam(BaseCodingDt theCodingDt)

Constructor which copies the system and code from a InternalCodingDt instance and adds it as a parameter

Parameters:

theCodingDt - The coding

TokenParam

public TokenParam(BaseIdentifierDt theIdentifierDt)

Constructor which copies the system and value from a BaseIdentifierDt instance and adds it as a parameter

Parameters:

theIdentifierDt - The identifier

TokenParam

public TokenParam(String theSystem,
                  String theValue)

TokenParam

public TokenParam(String theSystem,
                  String theValue,
                  boolean theText)

Method Detail

getModifier

public TokenParamModifier getModifier()

Returns the modifier for this token

getSystem

public String getSystem()

Returns the system for this token. Note that if a getModifier() is being used, the entire value of the parameter will be placed in value and this method will return null.

getValue

public String getValue()

Returns the value for the token

getValueAsCoding

public InternalCodingDt getValueAsCoding()

getValueNotNull

public String getValueNotNull()

isEmpty

public boolean isEmpty()

isText

public boolean isText()

Returns true if getModifier() returns TokenParamModifier.TEXT

setModifier

public TokenParam setModifier(TokenParamModifier theModifier)

setSystem

public TokenParam setSystem(String theSystem)

setText

@Deprecated
public TokenParam setText(boolean theText)

Deprecated. Use setModifier(TokenParamModifier) instead

setValue

public TokenParam setValue(String 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"