ca.uhn.fhir.rest.param

Class DateRangeParam

java.lang.Object

ca.uhn.fhir.rest.param.DateRangeParam

All Implemented Interfaces:

IQueryParameterAnd<DateParam>, Serializable

public class DateRangeParam
extends Object
implements IQueryParameterAnd<DateParam>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateRangeParam() Basic constructor.
DateRangeParam(Date theLowerBound, Date theUpperBound) Constructor which takes two Dates representing the lower and upper bounds of the range (inclusive on both ends)
DateRangeParam(DateParam theDateParam) Sets the range from a single date param.
DateRangeParam(DateParam theLowerBound, DateParam theUpperBound) Constructor which takes two Dates representing the lower and upper bounds of the range (inclusive on both ends)
DateRangeParam(IPrimitiveType<Date> theLowerBound, IPrimitiveType<Date> theUpperBound) Constructor which takes two Dates representing the lower and upper bounds of the range (inclusive on both ends)
DateRangeParam(String theLowerBound, String theUpperBound) Constructor which takes two strings representing the lower and upper bounds of the range (inclusive on both ends)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
DateParam	getLowerBound()
Date	getLowerBoundAsInstant()
DateParam	getUpperBound()
Date	getUpperBoundAsInstant()
List<DateParam>	getValuesAsQueryTokens() See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format
int	hashCode()
boolean	isEmpty()
DateRangeParam	setLowerBound(DateParam theLowerBound)
DateRangeParam	setLowerBound(String theLowerBound) Sets the lower bound using a string that is compliant with FHIR dateTime format (ISO-8601).
DateRangeParam	setLowerBoundExclusive(Date theLowerBound) Sets the lower bound to be greaterthan to the given date
DateRangeParam	setLowerBoundInclusive(Date theLowerBound) Sets the lower bound to be greaterthan or equal to the given date
void	setRangeFromDatesInclusive(Date theLowerBound, Date theUpperBound) Sets the range from a pair of dates, inclusive on both ends
void	setRangeFromDatesInclusive(DateParam theLowerBound, DateParam theUpperBound) Sets the range from a pair of dates, inclusive on both ends
void	setRangeFromDatesInclusive(IPrimitiveType<Date> theLowerBound, IPrimitiveType<Date> theUpperBound) Sets the range from a pair of dates, inclusive on both ends.
void	setRangeFromDatesInclusive(String theLowerBound, String theUpperBound) Sets the range from a pair of dates, inclusive on both ends
DateRangeParam	setUpperBound(DateParam theUpperBound)
DateRangeParam	setUpperBound(String theUpperBound) Sets the upper bound using a string that is compliant with FHIR dateTime format (ISO-8601).
DateRangeParam	setUpperBoundExclusive(Date theUpperBound) Sets the upper bound to be greaterthan to the given date
DateRangeParam	setUpperBoundInclusive(Date theUpperBound) Sets the upper bound to be greaterthan or equal to the given date
void	setValuesAsQueryTokens(FhirContext theContext, String theParamName, List<QualifiedParamList> theParameters) See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DateRangeParam

public DateRangeParam()

Basic constructor. Values must be supplied by calling setLowerBound(DateParam) and setUpperBound(DateParam)

DateRangeParam

public DateRangeParam(Date theLowerBound,
                      Date theUpperBound)

Constructor which takes two Dates representing the lower and upper bounds of the range (inclusive on both ends)

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

DateRangeParam

public DateRangeParam(DateParam theDateParam)

Sets the range from a single date param. If theDateParam has no qualifier, treats it as the lower and upper bound (e.g. 2011-01-02 would match any time on that day). If theDateParam has a qualifier, treats it as either the lower or upper bound, with no opposite bound.

DateRangeParam

public DateRangeParam(DateParam theLowerBound,
                      DateParam theUpperBound)

Constructor which takes two Dates representing the lower and upper bounds of the range (inclusive on both ends)

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

DateRangeParam

public DateRangeParam(IPrimitiveType<Date> theLowerBound,
                      IPrimitiveType<Date> theUpperBound)

Constructor which takes two Dates representing the lower and upper bounds of the range (inclusive on both ends)

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

DateRangeParam

public DateRangeParam(String theLowerBound,
                      String theUpperBound)

Constructor which takes two strings representing the lower and upper bounds of the range (inclusive on both ends)

Parameters:

theLowerBound - An unqualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - An unqualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getLowerBound

public DateParam getLowerBound()

setLowerBound

public DateRangeParam setLowerBound(DateParam theLowerBound)

setLowerBound

public DateRangeParam setLowerBound(String theLowerBound)

Sets the lower bound using a string that is compliant with FHIR dateTime format (ISO-8601).

This lower bound is assumed to have a ge (greater than or equals) modifier.

setLowerBoundInclusive

public DateRangeParam setLowerBoundInclusive(Date theLowerBound)

Sets the lower bound to be greaterthan or equal to the given date

setUpperBoundInclusive

public DateRangeParam setUpperBoundInclusive(Date theUpperBound)

Sets the upper bound to be greaterthan or equal to the given date

setLowerBoundExclusive

public DateRangeParam setLowerBoundExclusive(Date theLowerBound)

Sets the lower bound to be greaterthan to the given date

setUpperBoundExclusive

public DateRangeParam setUpperBoundExclusive(Date theUpperBound)

Sets the upper bound to be greaterthan to the given date

getLowerBoundAsInstant

public Date getLowerBoundAsInstant()

getUpperBound

public DateParam getUpperBound()

setUpperBound

public DateRangeParam setUpperBound(String theUpperBound)

Sets the upper bound using a string that is compliant with FHIR dateTime format (ISO-8601).

This upper bound is assumed to have a le (less than or equals) modifier.

setUpperBound

public DateRangeParam setUpperBound(DateParam theUpperBound)

getUpperBoundAsInstant

public Date getUpperBoundAsInstant()

getValuesAsQueryTokens

public List<DateParam> getValuesAsQueryTokens()

Description copied from interface: IQueryParameterAnd

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

getValuesAsQueryTokens in interface IQueryParameterAnd<DateParam>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

setRangeFromDatesInclusive

public void setRangeFromDatesInclusive(Date theLowerBound,
                                       Date theUpperBound)

Sets the range from a pair of dates, inclusive on both ends

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

setRangeFromDatesInclusive

public void setRangeFromDatesInclusive(DateParam theLowerBound,
                                       DateParam theUpperBound)

Sets the range from a pair of dates, inclusive on both ends

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

setRangeFromDatesInclusive

public void setRangeFromDatesInclusive(IPrimitiveType<Date> theLowerBound,
                                       IPrimitiveType<Date> theUpperBound)

Sets the range from a pair of dates, inclusive on both ends. Note that if theLowerBound is after theUpperBound, thie method will automatically reverse the order of the arguments in order to create an inclusive range.

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

setRangeFromDatesInclusive

public void setRangeFromDatesInclusive(String theLowerBound,
                                       String theUpperBound)

Sets the range from a pair of dates, inclusive on both ends

Parameters:

theLowerBound - A qualified date param representing the lower date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

theUpperBound - A qualified date param representing the upper date bound (optionally may include time), e.g. "2011-02-22" or "2011-02-22T13:12:00Z". Will be treated inclusively. Either theLowerBound or theUpperBound may both be populated, or one may be null, but it is not valid for both to be null.

setValuesAsQueryTokens

public void setValuesAsQueryTokens(FhirContext theContext,
                                   String theParamName,
                                   List<QualifiedParamList> theParameters)
                            throws InvalidRequestException

Description copied from interface: IQueryParameterAnd

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

setValuesAsQueryTokens in interface IQueryParameterAnd<DateParam>

Parameters:

theContext - TODO

theParamName - TODO

Throws:

InvalidRequestException

toString

public String toString()

Overrides:

toString in class Object