ca.uhn.hl7v2.model.primitive
Class TSComponentOne

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.AbstractPrimitive
          ca.uhn.hl7v2.model.primitive.TSComponentOne

All Implemented Interfaces:

Primitive, Type, Serializable

Direct Known Subclasses:

DTM, DTM, DTM, TS, TSComponentOne, TSComponentOne, TSComponentOne, TSComponentOne

public abstract class TSComponentOne
extends AbstractPrimitive

Represents an HL7 timestamp, which is related to the HL7 TS type. In version 2.5, TS is a composite type. The first component is type DTM, which corresponds to this class (actually model.v25.datatype.DTM inherits from this class at time of writing). In HL7 versions 2.2-2.4, it wasn't perfectly clear whether TS was composite or primitive. HAPI interprets it as composite, with the first component having a type that isn't defined by HL7, and we call this type TSComponentOne. In v2.1, TS is primitive, and corresponds one-to-one with this class.

Version:

$Revision: 1.2 $ updated on $Date: 2011-02-21 17:55:08 $ by $Author: jamesagnew $

Author:

Neal Acharya, Bryan Tripp

See Also:

Serialized Form

Constructor Summary

TSComponentOne(Message theMessage)

Method Summary

int	getDay() Returns the day as an integer.
float	getFractSecond() Returns the fractional second value as a float.
int	getGMTOffset() Returns the GMT offset value as an integer.
int	getHour() Returns the hour as an integer.
int	getMinute() Returns the minute as an integer.
int	getMonth() Returns the month as an integer.
int	getSecond() Returns the second as an integer.
String	getValue() Returns a String representation of the value of this field.
Calendar	getValueAsCalendar() Return the value as a calendar object
Date	getValueAsDate() Return the value as a date object Note: Sets fields using precision up to the second
int	getYear() Returns the year as an integer.
void	setDateMinutePrecision(int yr, int mnth, int dy, int hr, int min)
void	setDatePrecision(int yr, int mnth, int dy)
void	setDateSecondPrecision(int yr, int mnth, int dy, int hr, int min, float sec)
void	setOffset(int signedOffset)
void	setValue(Calendar theCalendar) Convenience setter which sets the value using a Calendar object.
void	setValue(Date theDate) Convenience setter which sets the value using a Calendar object.
void	setValue(String theValue) Sets the value of this Primitive, first performing validation as specified by getMessage().getValidationContext().
void	setValueToMinute(Calendar theCalendar) Convenience setter which sets the value using a Calendar object.
void	setValueToMinute(Date theDate) Convenience setter which sets the value using a Date object.
void	setValueToSecond(Calendar theCalendar) Convenience setter which sets the value using a Calendar object.
void	setValueToSecond(Date theDate) Convenience setter which sets the value using a Date object.

Methods inherited from class ca.uhn.hl7v2.model.AbstractPrimitive

clear, encode, parse, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

getExtraComponents, getMessage, getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Type

getExtraComponents, getMessage, getName

Constructor Detail

TSComponentOne

public TSComponentOne(Message theMessage)

Parameters:

theMessage - message to which this Type belongs

Method Detail

setValue

public void setValue(String theValue)
              throws DataTypeException

Description copied from class: AbstractPrimitive

Sets the value of this Primitive, first performing validation as specified by getMessage().getValidationContext(). No validation is performed if getMessage() returns null.

Specified by:

setValue in interface Primitive

Overrides:

setValue in class AbstractPrimitive

Throws:

DataTypeException - if the value is incorrectly formatted and either validation is enabled for this primitive or detail setters / getters have been called, forcing further parsing.

See Also:

AbstractPrimitive.setValue(java.lang.String)

getValue

public String getValue()

Description copied from interface: Primitive

Returns a String representation of the value of this field.

Specified by:

getValue in interface Primitive

Overrides:

getValue in class AbstractPrimitive

See Also:

AbstractPrimitive.getValue()

setDatePrecision

public void setDatePrecision(int yr,
                             int mnth,
                             int dy)
                      throws DataTypeException

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

See Also:

CommonTS.setDatePrecision(int, int, int)

setDateMinutePrecision

public void setDateMinutePrecision(int yr,
                                   int mnth,
                                   int dy,
                                   int hr,
                                   int min)
                            throws DataTypeException

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

See Also:

CommonTS.setDateMinutePrecision(int, int, int, int, int)

setDateSecondPrecision

public void setDateSecondPrecision(int yr,
                                   int mnth,
                                   int dy,
                                   int hr,
                                   int min,
                                   float sec)
                            throws DataTypeException

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

See Also:

CommonTS.setDateSecondPrecision(int, int, int, int, int, float)

setOffset

public void setOffset(int signedOffset)
               throws DataTypeException

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

See Also:

CommonTS.setOffset(int)

getYear

public int getYear()
            throws DataTypeException

Returns the year as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getMonth

public int getMonth()
             throws DataTypeException

Returns the month as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getDay

public int getDay()
           throws DataTypeException

Returns the day as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getHour

public int getHour()
            throws DataTypeException

Returns the hour as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getMinute

public int getMinute()
              throws DataTypeException

Returns the minute as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getSecond

public int getSecond()
              throws DataTypeException

Returns the second as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getFractSecond

public float getFractSecond()
                     throws DataTypeException

Returns the fractional second value as a float.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

getGMTOffset

public int getGMTOffset()
                 throws DataTypeException

Returns the GMT offset value as an integer.

Throws:

DataTypeException - if the value is incorrectly formatted. If validation is enabled, this exception should be thrown at setValue(), but if not, detailed parsing may be deferred until this method is called.

setValue

public void setValue(Calendar theCalendar)
              throws DataTypeException

Convenience setter which sets the value using a Calendar object. Note: Sets fields using precision up to the millisecond, including timezone offset

Parameters:

theCalendar - The calendar object from which to retrieve values

Throws:

DataTypeException

Since:

1.1

setValue

public void setValue(Date theDate)
              throws DataTypeException

Convenience setter which sets the value using a Calendar object. Note: Sets fields using precision up to the millisecond, and sets the timezone offset to the current system offset Note: Date is timezone-agnostic, representing always GMT time

Parameters:

theDate - The date object from which to retrieve values

Throws:

DataTypeException

Since:

1.1

setValueToMinute

public void setValueToMinute(Calendar theCalendar)
                      throws DataTypeException

Convenience setter which sets the value using a Calendar object. Note: Sets fields using precision up to the minute

Parameters:

theCalendar - The calendar object from which to retrieve values

Throws:

DataTypeException

Since:

1.1

setValueToMinute

public void setValueToMinute(Date theDate)
                      throws DataTypeException

Convenience setter which sets the value using a Date object. Note: Sets fields using precision up to the minute Note: Date is timezone-agnostic, representing always GMT time

Parameters:

theDate - The date object from which to retrieve values

Throws:

DataTypeException

Since:

1.1

setValueToSecond

public void setValueToSecond(Calendar theCalendar)
                      throws DataTypeException

Convenience setter which sets the value using a Calendar object. Note: Sets fields using precision up to the second

Parameters:

theCalendar - The calendar object from which to retrieve values

Throws:

DataTypeException

Since:

1.1

setValueToSecond

public void setValueToSecond(Date theDate)
                      throws DataTypeException

Convenience setter which sets the value using a Date object. Note: Sets fields using precision up to the second

Parameters:

theDate - The date object from which to retrieve values

Throws:

DataTypeException

Since:

1.1

getValueAsCalendar

public Calendar getValueAsCalendar()
                            throws DataTypeException

Return the value as a calendar object

Throws:

DataTypeException - If the current underlying string representation can not be parsed into a valid date/time

Since:

1.1

getValueAsDate

public Date getValueAsDate()
                    throws DataTypeException

Return the value as a date object Note: Sets fields using precision up to the second

Throws:

DataTypeException - If the current underlying string representation can not be parsed into a valid date/time

Since:

1.1