org.dellroad.hl7

Class MSHSegment

java.lang.Object

org.dellroad.hl7.HL7Segment

org.dellroad.hl7.MSHSegment

All Implemented Interfaces:

Serializable

public class MSHSegment
extends HL7Segment

Represents an MSH segment.

This subclass does not allow accessing MSH.1 or MSH.2 except indirectly via getHL7Seps() and setHL7Seps().

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PROCESSING_ID
static String	DEFAULT_VERSION_ID
static String	MSA_SEGMENT_NAME
static String	MSH_SEGMENT_NAME
static String	TIMESTAMP_FORMAT

Fields inherited from class org.dellroad.hl7.HL7Segment

fields

Constructor Summary

Constructors

Constructor and Description
MSHSegment() Convenience constructor.
MSHSegment(HL7Seps seps) Constructor.
MSHSegment(MSHSegment msh) Copy constructor.
MSHSegment(String line) Parsing constructor.

Method Summary

Modifier and Type	Method and Description
void	append(StringBuilder buf, HL7Seps seps) Append string encoding of this segment to the provided buffer.
HL7Message	createACK(long serno) Create an acknowlegement message for this message.
HL7Field	getControlID() Returns control ID from MSH.10.
HL7Seps	getHL7Seps() Get the separator and escape characters defined by MSH.1 and MSH.2.
HL7Field	getMessageType() Returns message type from MSH.9.
HL7Field	getProcessingID() Returns control ID from MSH.11.
HL7Field	getReceivingApplication() Returns receiving application from MSH.5.
HL7Field	getReceivingFacility() Returns receiving facility from MSH.6.
HL7Field	getSendingApplication() Returns sending application from MSH.3.
HL7Field	getSendingFacility() Returns sending facility from MSH.4.
HL7Field	getTimestamp() Returns message timestamp from MSH.7.
HL7Field	getVersionID() Returns HL7 version from MSH.12.
boolean	isACK(HL7Message ack) Check whether the given message is an acknowlegement of this MSH.
void	setControlID(HL7Field field)
void	setField(int index, HL7Field field) This subclass version disallows setting MSH.1 or MSH.2 directly.
void	setHL7Seps(HL7Seps seps) Set MSH.1 and MSH.2 based on the provided separator and escape characters.
void	setMessageType(HL7Field field)
void	setProcessingID(HL7Field field)
void	setReceivingApplication(HL7Field field)
void	setReceivingFacility(HL7Field field)
void	setSendingApplication(HL7Field field)
void	setSendingFacility(HL7Field field)
void	setTimestamp(HL7Field field)
void	setVersionID(HL7Field field)
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) This subclass version disallows trimming away MSH.1 or MSH.2.

Methods inherited from class org.dellroad.hl7.HL7Segment

appendField, equals, getField, getFields, getName, getNumFields, hashCode, parseAndAddFields, setField, setName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROCESSING_ID

public static final String DEFAULT_PROCESSING_ID

See Also:

Constant Field Values

DEFAULT_VERSION_ID

public static final String DEFAULT_VERSION_ID

See Also:

Constant Field Values

MSH_SEGMENT_NAME

public static final String MSH_SEGMENT_NAME

See Also:

Constant Field Values

MSA_SEGMENT_NAME

public static final String MSA_SEGMENT_NAME

See Also:

Constant Field Values

TIMESTAMP_FORMAT

public static final String TIMESTAMP_FORMAT

See Also:

Constant Field Values

Constructor Detail

MSHSegment

public MSHSegment(String line)
           throws HL7ContentException

Parsing constructor.

Parameters:

line - encoded HL7 MSH segment

Throws:

HL7ContentException - if segment is invalid

MSHSegment

public MSHSegment(HL7Seps seps)

Constructor. This constructor initializes only MSH.1 and MSH.2.

Parameters:

seps - separator and escape characters for this message

MSHSegment

public MSHSegment()

Convenience constructor. Equivalent to:

MSHSegment(HL7Seps.DEFAULT)

MSHSegment

public MSHSegment(MSHSegment msh)

Copy constructor.

Parameters:

msh - MSH segment to copy

Method Detail

getSendingApplication

public HL7Field getSendingApplication()

Returns sending application from MSH.3.

Returns:

MSH.3, or null if there is none

setSendingApplication

public void setSendingApplication(HL7Field field)

getSendingFacility

public HL7Field getSendingFacility()

Returns sending facility from MSH.4.

Returns:

MSH.4, or null if there is none

setSendingFacility

public void setSendingFacility(HL7Field field)

getReceivingApplication

public HL7Field getReceivingApplication()

Returns receiving application from MSH.5.

Returns:

MSH.5, or null if there is none

setReceivingApplication

public void setReceivingApplication(HL7Field field)

getReceivingFacility

public HL7Field getReceivingFacility()

Returns receiving facility from MSH.6.

Returns:

MSH.6, or null if there is none

setReceivingFacility

public void setReceivingFacility(HL7Field field)

getTimestamp

public HL7Field getTimestamp()

Returns message timestamp from MSH.7.

Returns:

MSH.7, or null if there is none

setTimestamp

public void setTimestamp(HL7Field field)

getMessageType

public HL7Field getMessageType()

Returns message type from MSH.9.

Returns:

MSH.9, or null if there is none

setMessageType

public void setMessageType(HL7Field field)

getControlID

public HL7Field getControlID()

Returns control ID from MSH.10.

Returns:

MSH.10, or null if there is none

setControlID

public void setControlID(HL7Field field)

getProcessingID

public HL7Field getProcessingID()

Returns control ID from MSH.11.

Returns:

MSH.11, or null if there is none

setProcessingID

public void setProcessingID(HL7Field field)

getVersionID

public HL7Field getVersionID()

Returns HL7 version from MSH.12.

Returns:

MSH.12, or null if there is none

setVersionID

public void setVersionID(HL7Field field)

getHL7Seps

public HL7Seps getHL7Seps()

Get the separator and escape characters defined by MSH.1 and MSH.2.

Returns:

HL7 separators

setHL7Seps

public void setHL7Seps(HL7Seps seps)

Set MSH.1 and MSH.2 based on the provided separator and escape characters.

Parameters:

seps - HL7 separators

trimTo

public void trimTo(int size)

This subclass version disallows trimming away MSH.1 or MSH.2.

Overrides:

trimTo in class HL7Segment

Parameters:

size - maximum number of fields

Throws:

IllegalArgumentException - if size is less than three

setField

public void setField(int index,
                     HL7Field field)

This subclass version disallows setting MSH.1 or MSH.2 directly.

Overrides:

setField in class HL7Segment

Parameters:

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

field - field to set

Throws:

IllegalArgumentException - if index is less than three

IllegalArgumentException - if field is null

createACK

public HL7Message createACK(long serno)
                     throws HL7ContentException

Create an acknowlegement message for this message.

Parameters:

serno - next local HL7 serial number

Returns:

an acknowlegement of this message

Throws:

HL7ContentException - if the required fields are not present in this instance

isACK

public boolean isACK(HL7Message ack)
              throws HL7ContentException

Check whether the given message is an acknowlegement of this MSH.

Parameters:

ack - putative acknowlegement of this message

Returns:

true if ack is an acknowlegement of this MSH

Throws:

HL7ContentException - if the required fields are not present in this instance

IllegalArgumentException - if ack is null

append

public void append(StringBuilder buf,
                   HL7Seps seps)

Append string encoding of this segment to the provided buffer.

This overridden version ensures that MSH.1 and MSH.2 are not escaped.

Overrides:

append in class HL7Segment

Parameters:

buf - string buffer

seps - HL7 separator and escape characters

toString

public String toString(HL7Seps seps)

Convert to a string using the provided separators.

This overridden version ensures that MSH.1 and MSH.2 are consistent with seps in the generated string. This separators configured in this instance are not affected regardless.

Overrides:

toString in class HL7Segment

Parameters:

seps - HL7 separator and escape characters

Returns:

string form of this segment

Throws:

IllegalArgumentException - if seps is null

toString

public String toString()

Description copied from class: HL7Segment

Convert to a string using HL7Seps.DEFAULT.

Overrides:

toString in class HL7Segment