ca.uhn.fhir.rest.param

Class DateParam

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.api.BasePrimitive<Date>

ca.uhn.fhir.model.primitive.BaseDateTimeDt

ca.uhn.fhir.model.primitive.DateTimeDt

ca.uhn.fhir.rest.param.DateParam

All Implemented Interfaces:

IDatatype, IElement, IIdentifiableElement, IPrimitiveDatatype<Date>, IQueryParameterOr<DateParam>, IQueryParameterType, ISupportsUndeclaredExtensions, Externalizable, Serializable, IBase, IBaseDatatype, IPrimitiveType<Date>

Direct Known Subclasses:

QualifiedDateParam

public class DateParam
extends DateTimeDt
implements IQueryParameterType, IQueryParameterOr<DateParam>

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.fhir.model.primitive.DateTimeDt

DEFAULT_PRECISION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
QuantityCompararatorEnum	getComparator() Returns the comparator, or null if none has been set
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")
DateTimeDt	getValueAsDateTimeDt()
InstantDt	getValueAsInstantDt()
String	getValueAsQueryToken() Returns a representation of this parameter's value as it will be represented "over the wire".
List<DateParam>	getValuesAsQueryTokens()
boolean	isEmpty() Returns true if no date/time is specified.
void	setComparator(QuantityCompararatorEnum theComparator)
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
DateParam	setValue(Date theValue) Sets the value for this type using the given Java Date object as the time, and using the default precision for this datatype, as well as the local timezone as determined by the local operating system.
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.
void	setValuesAsQueryTokens(QualifiedParamList theParameters)
String	toString()

Methods inherited from class ca.uhn.fhir.model.primitive.DateTimeDt

getDefaultPrecisionForDatatype, withCurrentTime

Methods inherited from class ca.uhn.fhir.model.primitive.BaseDateTimeDt

encode, getPrecision, getTimeZone, isTimeZoneZulu, isToday, parse, setPrecision, setTimeZone, setTimeZoneZulu, setValue, setValueAsString, toHumanDisplay, toHumanDisplayLocalTimezone

Methods inherited from class ca.uhn.fhir.model.api.BasePrimitive

equals, getValue, getValueAsString, hashCode, readExternal, updateStringValue, writeExternal

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateParam

public DateParam()

Constructor

DateParam

public DateParam(QuantityCompararatorEnum theComparator,
                 Date theDate)

Constructor

DateParam

public DateParam(QuantityCompararatorEnum theComparator,
                 DateTimeDt theDate)

Constructor

DateParam

public DateParam(QuantityCompararatorEnum theComparator,
                 IPrimitiveType<Date> theDate)

Constructor

DateParam

public DateParam(QuantityCompararatorEnum theComparator,
                 long theDate)

Constructor

DateParam

public DateParam(QuantityCompararatorEnum theComparator,
                 String theDate)

Constructor

DateParam

public DateParam(String theString)

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

Parameters:

theString - The string

Method Detail

getComparator

public QuantityCompararatorEnum getComparator()

Returns the comparator, or null if none has been set

getMissing

public Boolean getMissing()

Description copied from interface: IQueryParameterType

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

getValueAsDateTimeDt

public DateTimeDt getValueAsDateTimeDt()

getValueAsInstantDt

public InstantDt getValueAsInstantDt()

getValueAsQueryToken

public 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)

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.

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class BasePrimitive<Date>

setComparator

public void setComparator(QuantityCompararatorEnum theComparator)

setMissing

public void setMissing(Boolean theMissing)

Description copied from interface: IQueryParameterType

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

setValue

public DateParam setValue(Date theValue)

Description copied from class: BaseDateTimeDt

Sets the value for this type using the given Java Date object as the time, and using the default precision for this datatype, as well as the local timezone as determined by the local operating system. Both of these properties may be modified in subsequent calls if neccesary.

Specified by:

setValue in interface IPrimitiveDatatype<Date>

Specified by:

setValue in interface IPrimitiveType<Date>

Overrides:

setValue in class BaseDateTimeDt

setValueAsQueryToken

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

setValuesAsQueryTokens

public void setValuesAsQueryTokens(QualifiedParamList theParameters)

Specified by:

setValuesAsQueryTokens in interface IQueryParameterOr<DateParam>

toString

public String toString()

Overrides:

toString in class BasePrimitive<Date>