com.illcode.hl7

Class HL7Params

java.lang.Object

com.illcode.hl7.HL7Params

public final class HL7Params
extends java.lang.Object

An instance of HL7Params stores the settings used to encode/decode HL7v2 messages. These are, basically, the field separator, encoding characters, and character set found in the MSH segment.

Field Summary

Fields

Modifier and Type	Field and Description
char	componentSeparator
char	escapeChar
char	fieldSeparator
char[]	fieldValueSeparators An array of the separators in "descending" order of a parse tree for field data: i.e.
char	repetitionSeparator
char	subcomponentSeparator

Constructor Summary

Constructors

Constructor and Description
HL7Params() Construct an HL7Params using the default separators and escape character.
HL7Params(char fieldSeparator, char componentSeparator, char subcomponentSeparator, char repetitionSeparator, char escapeChar) Construct an HL7Params using the given separators and escape character.
HL7Params(java.lang.String MSHText) Construct an HL7Params using the separators and escape character found in the MSH segment text given as an argument.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	escape(java.lang.String s) Escapes text given the separators and escape character in this HL7Params instance.
java.lang.String	unescape(java.lang.String s) Unescapes text given the separators and escape character in this HL7Params instance.

Methods inherited from class java.lang.Object

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

Field Detail

fieldSeparator

public final char fieldSeparator

componentSeparator

public final char componentSeparator

subcomponentSeparator

public final char subcomponentSeparator

repetitionSeparator

public final char repetitionSeparator

escapeChar

public final char escapeChar

fieldValueSeparators

public char[] fieldValueSeparators

An array of the separators in "descending" order of a parse tree for field data:
i.e. [repetitionSeparator, componentSeparator, subcomponentSeparator]

Constructor Detail

HL7Params

public HL7Params()

Construct an HL7Params using the default separators and escape character.

HL7Params

public HL7Params(char fieldSeparator,
         char componentSeparator,
         char subcomponentSeparator,
         char repetitionSeparator,
         char escapeChar)

Construct an HL7Params using the given separators and escape character.

HL7Params

public HL7Params(java.lang.String MSHText)

Construct an HL7Params using the separators and escape character found in the MSH segment text given as an argument.

Method Detail

escape

public java.lang.String escape(java.lang.String s)

Escapes text given the separators and escape character in this HL7Params instance.

For instance, given the default HL7 delimeters and escape character,

"It's ~20 lbs & 3 oz" → "It's \R\20 lbs \T\ 3 oz"

Parameters:

s - string to escape

Returns:

escaped string

unescape

public java.lang.String unescape(java.lang.String s)

Unescapes text given the separators and escape character in this HL7Params instance.

For instance, given the default HL7 delimeters and escape character,

"It's \R\20 lbs \T\ 3 oz" → "It's ~20 lbs & 3 oz"

Parameters:

s - string to unescape

Returns:

unescaped string