com.merge.HL7.v251.fields
Class HL7FieldED

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

public class HL7FieldED
extends HL7Field

This data type transmits encapsulated data from a source system to a destination system. It contains the identity of the source system, the type of data, the encoding method of the data, and the data itself. This data type is similar to the RP (reference pointer) data type of Section 2.A.65, "RP - reference pointer," except that instead of pointing to the data on another system, it contains the data which is to be sent to that system.

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

HL7FieldED()
Creates an empty HL7 ED 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.
HL7FieldTX	getData() Gets the Data component of this field.
java.lang.String	getDataSubtype() Gets the Data Subtype component of this field.
java.lang.String	getDataValue() Gets the Data component of this field.
java.lang.String	getEncoding() Gets the Encoding component of this field.
int	getMaxSize() Gets the number of components defined for this field.
HL7FieldHD	getSourceApplication() Gets the Source Application component of this field.
java.lang.String	getSourceApplicationValue() Gets the Source Application component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
java.lang.String	getTypeOfData() Gets the Type of Data component of this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isDataEmpty() Tells whether the Data component has been specified.
boolean	isDataNull() Tells whether the Data component has a has Null value as defined by HL7.
boolean	isDataSubtypeEmpty() Tells whether the Data Subtype component has been specified.
boolean	isDataSubtypeNull() Tells whether the Data Subtype component has a has Null value as defined by HL7.
boolean	isEncodingEmpty() Tells whether the Encoding component has been specified.
boolean	isEncodingNull() Tells whether the Encoding component has a has Null value as defined by HL7.
boolean	isSourceApplicationEmpty() Tells whether the Source Application component has been specified.
boolean	isSourceApplicationNull() Tells whether the Source Application component has a has Null value as defined by HL7.
boolean	isTypeOfDataEmpty() Tells whether the Type of Data component has been specified.
boolean	isTypeOfDataNull() Tells whether the Type of Data component has a has Null value as defined by HL7.
void	setData(HL7FieldTX val) Sets the Data component of this field.
void	setDataSubtype(java.lang.String val) Sets the Data Subtype from a string.
void	setDataValue(java.lang.String val) Sets the Data from a string.
void	setEncoding(java.lang.String val) Sets the Encoding from a string.
void	setSourceApplication(HL7FieldHD val) Sets the Source Application component of this field.
void	setSourceApplicationValue(java.lang.String val) Sets the Source Application from a string.
void	setTypeOfData(java.lang.String val) Sets the Type of Data 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

HL7FieldED

public HL7FieldED()

Creates an empty HL7 ED 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.

getSourceApplicationValue

public java.lang.String getSourceApplicationValue()

Gets the Source Application component of this field.

Returns:

the Source Application value

setSourceApplicationValue

public void setSourceApplicationValue(java.lang.String val)

Sets the Source Application from a string.

Parameters:

val - The value to set for Source Application

getSourceApplication

public HL7FieldHD getSourceApplication()

Gets the Source Application component of this field.

Returns:

An HL7FieldHD object representing Source Application

setSourceApplication

public void setSourceApplication(HL7FieldHD val)

Sets the Source Application component of this field.

Parameters:

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

isSourceApplicationEmpty

public boolean isSourceApplicationEmpty()

Tells whether the Source Application component has been specified.

Returns:

true if the component is empty.

isSourceApplicationNull

public boolean isSourceApplicationNull()

Tells whether the Source Application component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getTypeOfData

public java.lang.String getTypeOfData()

Gets the Type of Data component of this field.

Returns:

the Type of Data value

setTypeOfData

public void setTypeOfData(java.lang.String val)

Sets the Type of Data from a string.

Parameters:

val - The value to set for Type of Data

isTypeOfDataEmpty

public boolean isTypeOfDataEmpty()

Tells whether the Type of Data component has been specified.

Returns:

true if the component is empty.

isTypeOfDataNull

public boolean isTypeOfDataNull()

Tells whether the Type of Data component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getDataSubtype

public java.lang.String getDataSubtype()

Gets the Data Subtype component of this field.

Returns:

the Data Subtype value

setDataSubtype

public void setDataSubtype(java.lang.String val)

Sets the Data Subtype from a string.

Parameters:

val - The value to set for Data Subtype

isDataSubtypeEmpty

public boolean isDataSubtypeEmpty()

Tells whether the Data Subtype component has been specified.

Returns:

true if the component is empty.

isDataSubtypeNull

public boolean isDataSubtypeNull()

Tells whether the Data Subtype component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getEncoding

public java.lang.String getEncoding()

Gets the Encoding component of this field.

Returns:

the Encoding value

setEncoding

public void setEncoding(java.lang.String val)

Sets the Encoding from a string.

Parameters:

val - The value to set for Encoding

isEncodingEmpty

public boolean isEncodingEmpty()

Tells whether the Encoding component has been specified.

Returns:

true if the component is empty.

isEncodingNull

public boolean isEncodingNull()

Tells whether the Encoding component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getDataValue

public java.lang.String getDataValue()

Gets the Data component of this field.

Returns:

the Data value

setDataValue

public void setDataValue(java.lang.String val)

Sets the Data from a string.

Parameters:

val - The value to set for Data

getData

public HL7FieldTX getData()

Gets the Data component of this field.

Returns:

An HL7FieldTX object representing Data

setData

public void setData(HL7FieldTX val)

Sets the Data component of this field.

Parameters:

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

isDataEmpty

public boolean isDataEmpty()

Tells whether the Data component has been specified.

Returns:

true if the component is empty.

isDataNull

public boolean isDataNull()

Tells whether the Data component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.