com.merge.HL7.v231.fields
Class HL7FieldEI

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v231.fields.HL7FieldEI

public class HL7FieldEI
extends HL7Field

The entity identifier defines a given entity within a specified series of identifiers.

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

HL7FieldEI()
Creates an empty HL7 EI 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.
java.lang.String	getEntityIdentifier() Gets the Entity Identifier component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getNamespaceID() Gets the Namespace ID component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
java.lang.String	getUniversalID() Gets the Universal ID component of this field.
java.lang.String	getUniversalIDType() Gets the Universal ID Type component of this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isEntityIdentifierEmpty() Tells whether the Entity Identifier component has been specified.
boolean	isEntityIdentifierNull() Tells whether the Entity Identifier component has a has Null value as defined by HL7.
boolean	isNamespaceIDEmpty() Tells whether the Namespace ID component has been specified.
boolean	isNamespaceIDNull() Tells whether the Namespace ID component has a has Null value as defined by HL7.
boolean	isUniversalIDEmpty() Tells whether the Universal ID component has been specified.
boolean	isUniversalIDNull() Tells whether the Universal ID component has a has Null value as defined by HL7.
boolean	isUniversalIDTypeEmpty() Tells whether the Universal ID Type component has been specified.
boolean	isUniversalIDTypeNull() Tells whether the Universal ID Type component has a has Null value as defined by HL7.
void	setEntityIdentifier(java.lang.String val) Sets the Entity Identifier from a string.
void	setNamespaceID(java.lang.String val) Sets the Namespace ID from a string.
void	setUniversalID(java.lang.String val) Sets the Universal ID from a string.
void	setUniversalIDType(java.lang.String val) Sets the Universal ID Type 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

HL7FieldEI

public HL7FieldEI()

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

getEntityIdentifier

public java.lang.String getEntityIdentifier()

Gets the Entity Identifier component of this field.

Returns:

the Entity Identifier value

setEntityIdentifier

public void setEntityIdentifier(java.lang.String val)

Sets the Entity Identifier from a string.

Parameters:

val - The value to set for Entity Identifier

isEntityIdentifierEmpty

public boolean isEntityIdentifierEmpty()

Tells whether the Entity Identifier component has been specified.

Returns:

true if the component is empty.

isEntityIdentifierNull

public boolean isEntityIdentifierNull()

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

Returns:

true if the component has the HL7 Null value.

getNamespaceID

public java.lang.String getNamespaceID()

Gets the Namespace ID component of this field.

Returns:

the Namespace ID value

setNamespaceID

public void setNamespaceID(java.lang.String val)

Sets the Namespace ID from a string.

Parameters:

val - The value to set for Namespace ID

isNamespaceIDEmpty

public boolean isNamespaceIDEmpty()

Tells whether the Namespace ID component has been specified.

Returns:

true if the component is empty.

isNamespaceIDNull

public boolean isNamespaceIDNull()

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

Returns:

true if the component has the HL7 Null value.

getUniversalID

public java.lang.String getUniversalID()

Gets the Universal ID component of this field.

Returns:

the Universal ID value

setUniversalID

public void setUniversalID(java.lang.String val)

Sets the Universal ID from a string.

Parameters:

val - The value to set for Universal ID

isUniversalIDEmpty

public boolean isUniversalIDEmpty()

Tells whether the Universal ID component has been specified.

Returns:

true if the component is empty.

isUniversalIDNull

public boolean isUniversalIDNull()

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

Returns:

true if the component has the HL7 Null value.

getUniversalIDType

public java.lang.String getUniversalIDType()

Gets the Universal ID Type component of this field.

Returns:

the Universal ID Type value

setUniversalIDType

public void setUniversalIDType(java.lang.String val)

Sets the Universal ID Type from a string.

Parameters:

val - The value to set for Universal ID Type

isUniversalIDTypeEmpty

public boolean isUniversalIDTypeEmpty()

Tells whether the Universal ID Type component has been specified.

Returns:

true if the component is empty.

isUniversalIDTypeNull

public boolean isUniversalIDTypeNull()

Tells whether the Universal ID Type component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.