org.hl7.fhir.instance.model

Class BaseDateTimeType

java.lang.Object

org.hl7.fhir.instance.model.Base

org.hl7.fhir.instance.model.Element

org.hl7.fhir.instance.model.Type

org.hl7.fhir.instance.model.PrimitiveType<Date>

org.hl7.fhir.instance.model.BaseDateTimeType

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IPrimitiveType<Date>

Direct Known Subclasses:

DateTimeType, DateType, InstantType

public abstract class BaseDateTimeType
extends PrimitiveType<Date>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hl7.fhir.instance.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
BaseDateTimeType() Constructor
BaseDateTimeType(Date theDate, TemporalPrecisionEnum thePrecision) Constructor
BaseDateTimeType(Date theDate, TemporalPrecisionEnum thePrecision, TimeZone theTimeZone) Constructor
BaseDateTimeType(String theString) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(int theField, int theValue) Adds the given amount to the field specified by theField
boolean	after(DateTimeType theDateTimeType)
boolean	before(DateTimeType theDateTimeType)
protected String	encode(Date theValue) Subclasses must override to convert a "coerced" value into an encoded one.
protected abstract TemporalPrecisionEnum	getDefaultPrecisionForDatatype() Returns the default precision for the given datatype
TemporalPrecisionEnum	getPrecision() Gets the precision for this datatype (using the default for the given type if not set)
long	getTime() Returns the time in millis as represented by this Date/Time
TimeZone	getTimeZone() Returns the TimeZone associated with this dateTime's value.
boolean	isTimeZoneZulu()
boolean	isToday() Returns true if this object represents a date that is today's date
protected Date	parse(String theValue) Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
void	setOffsetMinutes(int theZoneOffsetMinutes) Sets the TimeZone offset in minutes relative to GMT
void	setPrecision(TemporalPrecisionEnum thePrecision) Sets the precision for this datatype using field values from Calendar.
void	setTimeZone(TimeZone theTimeZone)
void	setTimeZoneZulu(boolean theTimeZoneZulu)
BaseDateTimeType	setValue(Date theValue) Sets the value of this date/time using the default level of precision for this datatype using the system local time zone
void	setValue(Date theValue, TemporalPrecisionEnum thePrecision) Sets the value of this date/time using the specified level of precision using the system local time zone
void	setValueAsString(String theValue)
protected void	setValueAsV3String(String theV3String)
Calendar	toCalendar() Returns a view of this date/time as a Calendar object
String	toHumanDisplay() Returns a human readable version of this date/time using the system local format.
String	toHumanDisplayLocalTimezone() Returns a human readable version of this date/time using the system local format, converted to the local timezone if neccesary.

Methods inherited from class org.hl7.fhir.instance.model.PrimitiveType

asStringValue, copy, equalsDeep, equalsShallow, fromStringValue, getValue, getValueAsString, hashCode, hasValue, isEmpty, isPrimitive, primitiveValue, toString, typedCopy, updateStringValue

Methods inherited from class org.hl7.fhir.instance.model.Element

addChild, addExtension, addExtension, copyValues, fhirType, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, listChildren, setId, setIdElement, setProperty

Methods inherited from class org.hl7.fhir.instance.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Constructor Detail

BaseDateTimeType

public BaseDateTimeType()

Constructor

BaseDateTimeType

public BaseDateTimeType(Date theDate,
                        TemporalPrecisionEnum thePrecision)

Constructor

Throws:

IllegalArgumentException - If the specified precision is not allowed for this type

BaseDateTimeType

public BaseDateTimeType(String theString)

Constructor

Throws:

IllegalArgumentException - If the specified precision is not allowed for this type

BaseDateTimeType

public BaseDateTimeType(Date theDate,
                        TemporalPrecisionEnum thePrecision,
                        TimeZone theTimeZone)

Constructor

Method Detail

encode

protected String encode(Date theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert a "coerced" value into an encoded one.

Specified by:

encode in class PrimitiveType<Date>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

getDefaultPrecisionForDatatype

protected abstract TemporalPrecisionEnum getDefaultPrecisionForDatatype()

Returns the default precision for the given datatype

getPrecision

public TemporalPrecisionEnum getPrecision()

Gets the precision for this datatype (using the default for the given type if not set)

See Also:

setPrecision(TemporalPrecisionEnum)

getTimeZone

public TimeZone getTimeZone()

Returns the TimeZone associated with this dateTime's value. May return null if no timezone was supplied.

isTimeZoneZulu

public boolean isTimeZoneZulu()

isToday

public boolean isToday()

Returns true if this object represents a date that is today's date

Throws:

NullPointerException - if PrimitiveType.getValue() returns null

parse

protected Date parse(String theValue)
              throws IllegalArgumentException

Description copied from class: PrimitiveType

Subclasses must override to convert an encoded representation of this datatype into a "coerced" one

Specified by:

parse in class PrimitiveType<Date>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

Throws:

IllegalArgumentException

setPrecision

public void setPrecision(TemporalPrecisionEnum thePrecision)
                  throws IllegalArgumentException

Sets the precision for this datatype using field values from Calendar. Valid values are:

• Calendar.SECOND
• Calendar.DAY_OF_MONTH
• Calendar.MONTH
• Calendar.YEAR

Throws:

IllegalArgumentException

setTimeZone

public void setTimeZone(TimeZone theTimeZone)

setTimeZoneZulu

public void setTimeZoneZulu(boolean theTimeZoneZulu)

setValue

public BaseDateTimeType setValue(Date theValue)

Sets the value of this date/time using the default level of precision for this datatype using the system local time zone

Specified by:

setValue in interface org.hl7.fhir.instance.model.api.IPrimitiveType<Date>

Overrides:

setValue in class PrimitiveType<Date>

Parameters:

theValue - The date value

setValue

public void setValue(Date theValue,
                     TemporalPrecisionEnum thePrecision)
              throws IllegalArgumentException

Sets the value of this date/time using the specified level of precision using the system local time zone

Parameters:

theValue - The date value

thePrecision - The precision

Throws:

IllegalArgumentException

setValueAsString

public void setValueAsString(String theValue)
                      throws IllegalArgumentException

Specified by:

setValueAsString in interface org.hl7.fhir.instance.model.api.IPrimitiveType<Date>

Overrides:

setValueAsString in class PrimitiveType<Date>

Throws:

IllegalArgumentException

before

public boolean before(DateTimeType theDateTimeType)

after

public boolean after(DateTimeType theDateTimeType)

toHumanDisplay

public String toHumanDisplay()

Returns a human readable version of this date/time using the system local format.

Note on time zones: This method renders the value using the time zone that is contained within the value. For example, if this date object contains the value "2012-01-05T12:00:00-08:00", the human display will be rendered as "12:00:00" even if the application is being executed on a system in a different time zone. If this behaviour is not what you want, use toHumanDisplayLocalTimezone() instead.

toHumanDisplayLocalTimezone

public String toHumanDisplayLocalTimezone()

Returns a human readable version of this date/time using the system local format, converted to the local timezone if neccesary.

See Also:

for a method which does not convert the time to the local timezone before rendering it.

toCalendar

public Calendar toCalendar()

Returns a view of this date/time as a Calendar object

setOffsetMinutes

public void setOffsetMinutes(int theZoneOffsetMinutes)

Sets the TimeZone offset in minutes relative to GMT

getTime

public long getTime()

Returns the time in millis as represented by this Date/Time

add

public void add(int theField,
                int theValue)

Adds the given amount to the field specified by theField

Parameters:

theField - The field, uses constants from Calendar such as Calendar.YEAR

theValue - The number to add (or subtract for a negative number)

setValueAsV3String

protected void setValueAsV3String(String theV3String)