com.illcode.hl7

Class Segment

java.lang.Object

com.illcode.hl7.Segment

public final class Segment
extends java.lang.Object

Field data in a single HL7v2 segment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Segment.FieldValue The value of a field (scalar or composite).

Constructor Summary

Constructors

Constructor and Description
Segment(java.lang.String id) Construct an empty segment with the given ID.
Segment(java.lang.String id, int sizeHint) Construct an empty segment with a hint about its final size.
Segment(java.lang.String id, java.util.List<java.util.List<Segment.FieldValue>> fieldValues) Construct a segment with the given ID and list of field values.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFieldValue(int fieldNo, Segment.FieldValue v) Add a value to a given field.
void	addFieldValue(int fieldNo, java.lang.String value) Add a scalar value to a given field.
void	clearFieldValues(int fieldNo) Clear any values from a given field
static Segment	copyOf(Segment orig) Create and return a new Segment that is a deep copy of the given segment.
java.lang.String	getFieldValue(int fieldNo) Equivalent to getFieldValue(fieldNo, 1, 0, 0).
java.lang.String	getFieldValue(int fieldNo, int componentNo) Equivalent to getFieldValue(fieldNo, 1, componentNo, 0).
java.lang.String	getFieldValue(int fieldNo, int componentNo, int subcomponentNo) Equivalent to getFieldValue(fieldNo, 1, componentNo, subcomponentNo).
java.lang.String	getFieldValue(int fieldNo, int repetition, int componentNo, int subcomponentNo) Return the string value of a given field/component/subcomponent, or the empty string ("") if the requested value does not exist, or is a null value.
java.lang.String	getId() Get the ID of this segment (ex.
void	putFieldValues(int fieldNo, java.util.List<Segment.FieldValue> repeatedFieldValues) Add or replace values for a field.
void	setFieldValue(int fieldNo, int repetition, int componentNo, int subcomponentNo, java.lang.String value) Set the scalar value for a specified field/repetition/component/subcomponent.
void	setFieldValue(int fieldNo, int componentNo, int subcomponentNo, java.lang.String value) Equivalent to setFieldValue(fieldNo, 1, componentNo, subcomponentNo, value).
void	setFieldValue(int fieldNo, int componentNo, java.lang.String value) Equivalent to setFieldValue(fieldNo, 1, componentNo, 0, value).
void	setFieldValue(int fieldNo, java.lang.String value) Equivalent to setFieldValue(fieldNo, 1, 0, 0, value).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Segment

public Segment(java.lang.String id)

Construct an empty segment with the given ID.

Segment

public Segment(java.lang.String id,
       java.util.List<java.util.List<Segment.FieldValue>> fieldValues)

Construct a segment with the given ID and list of field values.

Parameters:

id - segment ID

fieldValues - a list of list of field values. The outer list index represents the field #, and the inner list index represents the field repetitions.

Segment

public Segment(java.lang.String id,
       int sizeHint)

Construct an empty segment with a hint about its final size.

Parameters:

id - segment ID

sizeHint - hint as to the total number of fields for which we should allocate our internal data structures

Method Detail

getId

public java.lang.String getId()

Get the ID of this segment (ex. "MSH")

getFieldValue

public java.lang.String getFieldValue(int fieldNo,
                             int repetition,
                             int componentNo,
                             int subcomponentNo)

Return the string value of a given field/component/subcomponent, or the empty string ("") if the requested value does not exist, or is a null value. Requesting the first child of a scalar parent will return the value of the parent. Requesting the value of a parent that is a composite will return the value of its first child.

All parameters represent indices that start at 1.

Parameters:

fieldNo - field number (>= 1)

repetition - the repetition number, for fields that have repeated values (>= 1)

componentNo - component number (or 0, to indicate no component)

subcomponentNo - subcomponent number (or 0, to indicate no subcomponent)

Returns:

value of field/repetition/component/subcomponent, or empty string

getFieldValue

public java.lang.String getFieldValue(int fieldNo)

Equivalent to getFieldValue(fieldNo, 1, 0, 0).

getFieldValue

public java.lang.String getFieldValue(int fieldNo,
                             int componentNo)

Equivalent to getFieldValue(fieldNo, 1, componentNo, 0).

getFieldValue

public java.lang.String getFieldValue(int fieldNo,
                             int componentNo,
                             int subcomponentNo)

Equivalent to getFieldValue(fieldNo, 1, componentNo, subcomponentNo).

putFieldValues

public void putFieldValues(int fieldNo,
                  java.util.List<Segment.FieldValue> repeatedFieldValues)

Add or replace values for a field.

Parameters:

fieldNo - field number (>= 1)

repeatedFieldValues - list of repetitions of field values; a null value clears the field

clearFieldValues

public void clearFieldValues(int fieldNo)

Clear any values from a given field

Parameters:

fieldNo - field number (>= 1)

addFieldValue

public void addFieldValue(int fieldNo,
                 Segment.FieldValue v)

Add a value to a given field. If a value is already present in the specified field, the new value will be added as a repetition.

Parameters:

fieldNo - field number (>= 1)

v - field value to add

addFieldValue

public void addFieldValue(int fieldNo,
                 java.lang.String value)

Add a scalar value to a given field. If a value is already present in the specified field, the new value will be added as a repetition.

Parameters:

fieldNo - field number (>= 1)

value - scalar field value to add

setFieldValue

public void setFieldValue(int fieldNo,
                 int repetition,
                 int componentNo,
                 int subcomponentNo,
                 java.lang.String value)

Set the scalar value for a specified field/repetition/component/subcomponent. Any existing value will be replaced, and if a scalar value exists at a point where a composite value is needed, the scalar will be replaced (for instance, if you set the value for "PID.3.2" but "PID.3" is a scalar, the scalar value will be replaced by a composite with a null "PID.3.1" and the given value of "PID.3.2").

Parameters:

fieldNo - field number (>= 1)

repetition - the repetition number, for fields that have repeated values (>= 1)

componentNo - component number (or 0, to indicate no component)

subcomponentNo - subcomponent number (or 0, to indicate no subcomponent)

value - scalar value to set

setFieldValue

public void setFieldValue(int fieldNo,
                 java.lang.String value)

Equivalent to setFieldValue(fieldNo, 1, 0, 0, value).

setFieldValue

public void setFieldValue(int fieldNo,
                 int componentNo,
                 java.lang.String value)

Equivalent to setFieldValue(fieldNo, 1, componentNo, 0, value).

setFieldValue

public void setFieldValue(int fieldNo,
                 int componentNo,
                 int subcomponentNo,
                 java.lang.String value)

Equivalent to setFieldValue(fieldNo, 1, componentNo, subcomponentNo, value).

copyOf

public static Segment copyOf(Segment orig)

Create and return a new Segment that is a deep copy of the given segment.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object