org.dellroad.hl7

Class HL7Segment

java.lang.Object

org.dellroad.hl7.HL7Segment

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MSHSegment

public class HL7Segment
extends Object
implements Serializable

Represents one segment in an HL7 message.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<HL7Field>	fields

Constructor Summary

Constructors

Constructor and Description
HL7Segment(HL7Segment segment) Copy constructor.
HL7Segment(String name) Constructor that initializes the name of the segment only.
HL7Segment(String name, HL7Field[] fields) Constructor taking segment name and explicit fields.
HL7Segment(String line, HL7Seps seps) Constructor that parses a segment line.

Method Summary

Modifier and Type	Method and Description
void	append(StringBuilder buf, HL7Seps seps) Append string encoding of this segment to the provided buffer.
void	appendField(HL7Field field) Add a field to the end of this segment.
boolean	equals(Object obj)
HL7Field	getField(int index) Get a field by "HL7 index".
HL7Field[]	getFields() Get all of the fields, starting with the segment name.
String	getName() Get segment name, e.g., MSH, PV1, etc.
int	getNumFields() Get number of fields (including segment name).
int	hashCode()
protected void	parseAndAddFields(String line, HL7Seps seps) Parse fields from given line and add them.
void	setField(int index, HL7Field field) Set a field in this segment.
void	setField(int index, String value) Convenience method.
void	setName(String name) Set segment name.
String	toString() Convert to a string using HL7Seps.DEFAULT.
String	toString(HL7Seps seps) Convert to a string using the provided separators.
void	trimTo(int size) Trim off all but the first size fields.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

fields

protected final ArrayList<HL7Field> fields

Constructor Detail

HL7Segment

public HL7Segment(String name)
           throws HL7ContentException

Constructor that initializes the name of the segment only.

Parameters:

name - segment name

Throws:

HL7ContentException - if the name is an invalid segment name

HL7Segment

public HL7Segment(String name,
                  HL7Field[] fields)
           throws HL7ContentException

Constructor taking segment name and explicit fields.

Parameters:

name - segment name

fields - zero or more segment fields

Throws:

HL7ContentException - if the name is an invalid segment name

IllegalArgumentException - if any field in the array is null

HL7Segment

public HL7Segment(String line,
                  HL7Seps seps)
           throws HL7ContentException

Constructor that parses a segment line.

Parameters:

line - segment line

seps - separator and escape characters

Throws:

HL7ContentException - if the segment name is invalid

HL7Segment

public HL7Segment(HL7Segment segment)

Copy constructor.

Parameters:

segment - segment to copy

Method Detail

getName

public String getName()

Get segment name, e.g., MSH, PV1, etc. Equivalent to:

getField(0).get(0, 0, 0)

Returns:

name of this segment

setName

public void setName(String name)
             throws HL7ContentException

Set segment name.

Parameters:

name - new segment name

Throws:

HL7ContentException - if the name is an invalid segment name

getNumFields

public int getNumFields()

Get number of fields (including segment name).

Returns:

number of fields in this segment

appendField

public void appendField(HL7Field field)

Add a field to the end of this segment.

Parameters:

field - field to add

Throws:

IllegalArgumentException - if field is null

setField

public void setField(int index,
                     HL7Field field)

Set a field in this segment. If the segment doesn't have index fields, intermediate empty fields will be added.

This method cannot be used to set the segment name. Use setName(java.lang.String) for that.

Parameters:

field - field to set

index - index of the field in the segment (where zero is the segment name); must be at least one

Throws:

IllegalArgumentException - if field is null

IllegalArgumentException - if index is zero or less

setField

public void setField(int index,
                     String value)

Convenience method. Equivalent to:

setField(index, new HL7Field(value))

Parameters:

index - index of the field in the segment (where zero is the segment name); must be at least one

value - simple field value

getField

public HL7Field getField(int index)

Get a field by "HL7 index". E.g., if this message is "ABC", an index of 3 would return ABC.3. If index is zero, the name of this segment is returned.

Parameters:

index - of the requested field

Returns:

the requested field, or null if not present in this segment

Throws:

IllegalArgumentException - if index is negative

getFields

public HL7Field[] getFields()

Get all of the fields, starting with the segment name.

Returns:

all fields in this segment

trimTo

public void trimTo(int size)

Trim off all but the first size fields. If the current number of fields is already less than or equal to size then nothing happens.

Parameters:

size - maximum number of fields

Throws:

IllegalArgumentException - if size is less than one

append

public void append(StringBuilder buf,
                   HL7Seps seps)

Append string encoding of this segment to the provided buffer.

Parameters:

buf - string buffer

seps - HL7 separator and escape characters

toString

public String toString(HL7Seps seps)

Convert to a string using the provided separators.

Parameters:

seps - HL7 separator and escape characters

Returns:

string form of this segment

toString

public String toString()

Convert to a string using HL7Seps.DEFAULT.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

parseAndAddFields

protected void parseAndAddFields(String line,
                                 HL7Seps seps)
                          throws HL7ContentException

Parse fields from given line and add them.

Parameters:

line - segment or segment fragment

seps - separator and escape characters

Throws:

HL7ContentException - if this segment contains zero fields and the first field is not a valid segment name