ca.uhn.fhir.rest.param

Class DateParam

java.lang.Object

ca.uhn.fhir.rest.param.BaseParamWithPrefix<DateParam>

ca.uhn.fhir.rest.param.DateParam

All Implemented Interfaces:

IQueryParameterOr<DateParam>, IQueryParameterType, Serializable

public class DateParam
extends BaseParamWithPrefix<DateParam>
implements IQueryParameterOr<DateParam>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DateParam.DateParamDateTimeHolder

Constructor Summary

Constructors

Constructor and Description
DateParam() Constructor
DateParam(ParamPrefixEnum thePrefix, Date theDate) Constructor
DateParam(ParamPrefixEnum thePrefix, DateTimeDt theDate) Constructor
DateParam(ParamPrefixEnum thePrefix, IPrimitiveType<Date> theDate) Constructor
DateParam(ParamPrefixEnum thePrefix, long theDate) Constructor
DateParam(ParamPrefixEnum thePrefix, String theDate) Constructor
DateParam(String theString) Constructor which takes a complete [qualifier]{date} string.

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
TemporalPrecisionEnum	getPrecision()
String	getQueryParameterQualifier() This method will return any qualifier that should be appended to the parameter name (e.g ":exact")
Date	getValue()
DateTimeDt	getValueAsDateTimeDt()
InstantDt	getValueAsInstantDt()
String	getValueAsQueryToken(FhirContext theContext) Returns a representation of this parameter's value as it will be represented "over the wire".
String	getValueAsString()
List<DateParam>	getValuesAsQueryTokens()
boolean	isEmpty() Returns true if no date/time is specified.
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
DateParam	setValue(Date theValue) Sets the value of the param to the given date (sets to the millisecond precision, and will be encoded using the system local time zone).
void	setValue(IPrimitiveType<Date> theValue) Sets the value using a FHIR Date type, such as a DateDt, or a DateTimeType.
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.
void	setValueAsString(String theDate) Accepts values with or without a prefix (e.g.
void	setValuesAsQueryTokens(FhirContext theContext, String theParamName, QualifiedParamList theParameters)
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

Constructor Detail

DateParam

public DateParam()

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
                 Date theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
                 DateTimeDt theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
                 IPrimitiveType<Date> theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
                 long theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
                 String theDate)

Constructor

DateParam

public DateParam(String theString)

Constructor which takes a complete [qualifier]{date} string.

Parameters:

theString - The string

Method Detail

getPrecision

public TemporalPrecisionEnum getPrecision()

getValue

public Date getValue()

getValueAsDateTimeDt

public DateTimeDt getValueAsDateTimeDt()

getValueAsInstantDt

public InstantDt getValueAsInstantDt()

getValueAsString

public String getValueAsString()

getValuesAsQueryTokens

public List<DateParam> getValuesAsQueryTokens()

Specified by:

getValuesAsQueryTokens in interface IQueryParameterOr<DateParam>

isEmpty

public boolean isEmpty()

Returns true if no date/time is specified. Note that this method does not check the comparator, so a QualifiedDateParam with only a comparator and no date/time is considered empty.

setValue

public DateParam setValue(Date theValue)

Sets the value of the param to the given date (sets to the millisecond precision, and will be encoded using the system local time zone).

setValue

public void setValue(IPrimitiveType<Date> theValue)

Sets the value using a FHIR Date type, such as a DateDt, or a DateTimeType.

setValueAsString

public void setValueAsString(String theDate)

Accepts values with or without a prefix (e.g. gt2011-01-01 and 2011-01-01). If no prefix is provided in the given value, the existing prefix is preserved

setValuesAsQueryTokens

public void setValuesAsQueryTokens(FhirContext theContext,
                                   String theParamName,
                                   QualifiedParamList theParameters)

Specified by:

setValuesAsQueryTokens in interface IQueryParameterOr<DateParam>

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"