|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractPrimitive
ca.uhn.hl7v2.model.primitive.TSComponentOne
public abstract class TSComponentOne
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.
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. |
java.lang.String |
getValue()
Returns a String representation of the value of this field. |
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(java.lang.String theValue)
Sets the value of this Primitive, first performing validation as specified by getMessage().getValidationContext() . |
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 |
---|
public TSComponentOne(Message theMessage)
theMessage
- message to which this Type belongsMethod Detail |
---|
public void setValue(java.lang.String theValue) throws DataTypeException
AbstractPrimitive
getMessage().getValidationContext()
. No validation is performed
if getMessage() returns null.
setValue
in interface Primitive
setValue
in class AbstractPrimitive
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.AbstractPrimitive.setValue(java.lang.String)
public java.lang.String getValue()
Primitive
getValue
in interface Primitive
getValue
in class AbstractPrimitive
AbstractPrimitive.getValue()
public void setDatePrecision(int yr, int mnth, int dy) throws DataTypeException
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.CommonTS.setDatePrecision(int, int, int)
public void setDateMinutePrecision(int yr, int mnth, int dy, int hr, int min) throws DataTypeException
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.CommonTS.setDateMinutePrecision(int, int, int, int, int)
public void setDateSecondPrecision(int yr, int mnth, int dy, int hr, int min, float sec) throws DataTypeException
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.CommonTS.setDateSecondPrecision(int, int, int, int, int, float)
public void setOffset(int signedOffset) throws DataTypeException
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.CommonTS.setOffset(int)
public int getYear() throws DataTypeException
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.public int getMonth() throws DataTypeException
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.public int getDay() throws DataTypeException
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.public int getHour() throws DataTypeException
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.public int getMinute() throws DataTypeException
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.public int getSecond() throws DataTypeException
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.public float getFractSecond() throws DataTypeException
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.public int getGMTOffset() throws DataTypeException
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |