au.gov.nehta.model.cda.common.time

Class PrecisionDate

java.lang.Object

au.gov.nehta.model.cda.common.time.PrecisionDate

All Implemented Interfaces:

PreciseDate

Direct Known Subclasses:

DateOfDeathImpl, ProviderIndividualDateOfBirthDetailImpl

public class PrecisionDate
extends Object
implements PreciseDate

PrecisionDate

A Java Time ZonedDateTime that also holds a Precision type indicating the accuracy of the date.

Constructor Summary

Constructors

Constructor and Description
PrecisionDate() Create a Date with a Precision The default constructor creates dates with seconds precision, ie:yyyyMMddHHmmssZ
PrecisionDate(long timeInMilliseconds) Constructed with a default precision of seconds
PrecisionDate(Precision timePrecision) Constructed with a default precision of seconds
PrecisionDate(Precision timePrecision, long timeInMilliseconds) Construct a date with the specified precision
PrecisionDate(Precision timePrecision, ZonedDateTime date) * Construct a date with the specified precision equivalent to this(timePrecision, date.getTime())

Method Summary

Modifier and Type	Method and Description
ZonedDateTime	getDateTime()
Precision	getPrecision()
static PreciseDate	today() Convenience method to return the current date with DAY precision
String	toNarrativeForm() Return a string representation using the narrative form of formatter specified in the Precision
String	toString() A String representation using only the required precision in HL7 ISO 8601 format

Methods inherited from class java.lang.Object

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

Constructor Detail

PrecisionDate

public PrecisionDate()

Create a Date with a Precision
The default constructor creates dates with seconds precision, ie:yyyyMMddHHmmssZ

For other precise date use Precision(Precision p) or Precision(Precision p, long timeInMilliseconds)

See Also:

Precision

PrecisionDate

public PrecisionDate(long timeInMilliseconds)

Constructed with a default precision of seconds

Parameters:

timeInMilliseconds - the milliseconds since January 1, 1970, 00:00:00 GMT.

See Also:

System.currentTimeMillis()

PrecisionDate

public PrecisionDate(Precision timePrecision,
                     long timeInMilliseconds)

Construct a date with the specified precision

Parameters:

timeInMilliseconds - the milliseconds since January 1, 1970, 00:00:00 GMT.

timePrecision - the amount of time to use. eg: Precision.day indicating that hours, minutes and seconds are to be ignored

See Also:

System.currentTimeMillis()

PrecisionDate

public PrecisionDate(Precision timePrecision,
                     ZonedDateTime date)

* Construct a date with the specified precision equivalent to this(timePrecision, date.getTime())

Parameters:

timePrecision - the amount of time to use. eg: Precision.day indicating that hours, minutes and seconds are to be ignored

See Also:

System.currentTimeMillis()

PrecisionDate

public PrecisionDate(Precision timePrecision)

Constructed with a default precision of seconds

See Also:

System.currentTimeMillis()

Method Detail

today

public static PreciseDate today()

Convenience method to return the current date with DAY precision

getPrecision

public Precision getPrecision()

Specified by:

getPrecision in interface PreciseDate

Returns:

Precision the precision relevant to this date

toString

public String toString()

A String representation using only the required precision in HL7 ISO 8601 format

For example, a PrecisionDate with a Precision.Day accuracy will print yyyyMMdd while a PrecisionDate with a Precision.Millisecond with a millisecond accuracy will print yyyyMMddHHmmss.SSSZ

Overrides:

toString in class Object

getDateTime

public ZonedDateTime getDateTime()

Specified by:

getDateTime in interface PreciseDate

toNarrativeForm

public String toNarrativeForm()

Description copied from interface: PreciseDate

Return a string representation using the narrative form of formatter specified in the Precision

Specified by:

toNarrativeForm in interface PreciseDate