com.merge.HL7.v251.fields
Class HL7FieldDR

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v251.fields.HL7FieldDR

public class HL7FieldDR
extends HL7Field

DR cannot be legally expressed when embedded within another data type. Its use is constrained to a segment field.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldDR()
Creates an empty HL7 DR type field object.

Method Summary

java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
int	getMaxSize() Gets the number of components defined for this field.
HL7FieldTS	getRangeEndDateTime() Gets the Range End Date/Time component of this field.
java.lang.String	getRangeEndDateTimeValue() Gets the Range End Date/Time component of this field.
HL7FieldTS	getRangeStartDateTime() Gets the Range Start Date/Time component of this field.
java.lang.String	getRangeStartDateTimeValue() Gets the Range Start Date/Time component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isRangeEndDateTimeEmpty() Tells whether the Range End Date/Time component has been specified.
boolean	isRangeEndDateTimeNull() Tells whether the Range End Date/Time component has a has Null value as defined by HL7.
boolean	isRangeStartDateTimeEmpty() Tells whether the Range Start Date/Time component has been specified.
boolean	isRangeStartDateTimeNull() Tells whether the Range Start Date/Time component has a has Null value as defined by HL7.
void	setRangeEndDateTime(HL7FieldTS val) Sets the Range End Date/Time component of this field.
void	setRangeEndDateTimeValue(java.lang.String val) Sets the Range End Date/Time from a string.
void	setRangeStartDateTime(HL7FieldTS val) Sets the Range Start Date/Time component of this field.
void	setRangeStartDateTimeValue(java.lang.String val) Sets the Range Start Date/Time from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldDR

public HL7FieldDR()

Creates an empty HL7 DR type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getRangeStartDateTimeValue

public java.lang.String getRangeStartDateTimeValue()

Gets the Range Start Date/Time component of this field.

Returns:

the Range Start Date/Time value

setRangeStartDateTimeValue

public void setRangeStartDateTimeValue(java.lang.String val)

Sets the Range Start Date/Time from a string.

Parameters:

val - The value to set for Range Start Date/Time

getRangeStartDateTime

public HL7FieldTS getRangeStartDateTime()

Gets the Range Start Date/Time component of this field.

Returns:

An HL7FieldTS object representing Range Start Date/Time

setRangeStartDateTime

public void setRangeStartDateTime(HL7FieldTS val)

Sets the Range Start Date/Time component of this field.

Parameters:

val - An HL7FieldTS object containing the value to be set.

isRangeStartDateTimeEmpty

public boolean isRangeStartDateTimeEmpty()

Tells whether the Range Start Date/Time component has been specified.

Returns:

true if the component is empty.

isRangeStartDateTimeNull

public boolean isRangeStartDateTimeNull()

Tells whether the Range Start Date/Time component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getRangeEndDateTimeValue

public java.lang.String getRangeEndDateTimeValue()

Gets the Range End Date/Time component of this field.

Returns:

the Range End Date/Time value

setRangeEndDateTimeValue

public void setRangeEndDateTimeValue(java.lang.String val)

Sets the Range End Date/Time from a string.

Parameters:

val - The value to set for Range End Date/Time

getRangeEndDateTime

public HL7FieldTS getRangeEndDateTime()

Gets the Range End Date/Time component of this field.

Returns:

An HL7FieldTS object representing Range End Date/Time

setRangeEndDateTime

public void setRangeEndDateTime(HL7FieldTS val)

Sets the Range End Date/Time component of this field.

Parameters:

val - An HL7FieldTS object containing the value to be set.

isRangeEndDateTimeEmpty

public boolean isRangeEndDateTimeEmpty()

Tells whether the Range End Date/Time component has been specified.

Returns:

true if the component is empty.

isRangeEndDateTimeNull

public boolean isRangeEndDateTimeNull()

Tells whether the Range End Date/Time component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.