ca.uhn.fhir.rest.param

Class StringParam

java.lang.Object

ca.uhn.fhir.rest.param.StringParam

All Implemented Interfaces:

IQueryParameterType, Serializable

public class StringParam
extends Object
implements IQueryParameterType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringParam() Constructor
StringParam(String theValue) Constructor
StringParam(String theValue, boolean theExact) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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	getValue()
String	getValueAsQueryToken(FhirContext theContext) Returns a representation of this parameter's value as it will be represented "over the wire".
StringDt	getValueAsStringDt()
String	getValueNotNull()
boolean	isContains() String parameter modifier :contains
boolean	isEmpty()
boolean	isExact()
protected boolean	isSupportsChain() Does this parameter type support chained parameters (only reference should return true for this)
StringParam	setContains(boolean theContains) String parameter modifier :contains
StringParam	setExact(boolean theExact)
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
StringParam	setValue(String 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 java.lang.Object

clone, 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

StringParam

public StringParam()

Constructor

StringParam

public StringParam(String theValue)

Constructor

StringParam

public StringParam(String theValue,
                   boolean theExact)

Constructor

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getValue

public String getValue()

getValueAsStringDt

public StringDt getValueAsStringDt()

getValueNotNull

public String getValueNotNull()

isContains

public boolean isContains()

String parameter modifier :contains

isEmpty

public boolean isEmpty()

isExact

public boolean isExact()

setContains

public StringParam setContains(boolean theContains)

String parameter modifier :contains

setExact

public StringParam setExact(boolean theExact)

setValue

public StringParam 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(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"