Package org.dellroad.hl7.llp

Class MSH18CharsetDecoder

java.lang.Object

org.dellroad.hl7.llp.MSH18CharsetDecoder

All Implemented Interfaces:

CharsetDecoder

public class MSH18CharsetDecoder
extends Object
implements CharsetDecoder

Attempts to determine HL7 message character encoding by decoding header field MSH.18, if present, or falling back to a configured default as a last resort.

Instances are thread safe.

Field Summary

Fields

Modifier and Type	Field	Description
protected Charset	defaultCharset

Constructor Summary

Constructors

Constructor	Description
MSH18CharsetDecoder()	Constructor using ISO-8859-1 as the default charset.
MSH18CharsetDecoder(Charset defaultCharset)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
Charset	charsetForIncomingMessage(byte[] buf, int off, int len)	Determine the character encoding to use for an incoming HL7 message.
Charset	charsetForOutgoingMessage(HL7Message msg)	Determine the character encoding to use for an outgoing HL7 message.
Charset	decodeCharsetName(String name)	Decode a character encoding name found in MSH.18.
protected Charset	decodeMSH18(MSHSegment msh)	Read and decode the character encoding name from MSH.18, if possible.

Methods inherited from class java.lang.Object

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

Field Detail

defaultCharset

protected final Charset defaultCharset

Constructor Detail

MSH18CharsetDecoder

public MSH18CharsetDecoder()

Constructor using ISO-8859-1 as the default charset.

MSH18CharsetDecoder

public MSH18CharsetDecoder(Charset defaultCharset)

Primary constructor.

Parameters:

defaultCharset - default character encoding to use if unable to determine from MSH.18

Throws:

IllegalArgumentException - if defaultCharset is null

Method Detail

charsetForIncomingMessage

public Charset charsetForIncomingMessage(byte[] buf,
                                         int off,
                                         int len)

Description copied from interface: CharsetDecoder

Determine the character encoding to use for an incoming HL7 message.

Specified by:

charsetForIncomingMessage in interface CharsetDecoder

Parameters:

buf - raw HL7 message buffer

off - HL7 message offset in buf

len - HL7 message length in buf

Returns:

character encoding to use for the given message (never null)

charsetForOutgoingMessage

public Charset charsetForOutgoingMessage(HL7Message msg)

Description copied from interface: CharsetDecoder

Determine the character encoding to use for an outgoing HL7 message.

Specified by:

charsetForOutgoingMessage in interface CharsetDecoder

Parameters:

msg - HL7 message

Returns:

character encoding to use for the given message (never null)

decodeMSH18

protected Charset decodeMSH18(MSHSegment msh)

Read and decode the character encoding name from MSH.18, if possible.

Parameters:

msh - MSH segment

Returns:

decoded character encoding, or the default if unable

decodeCharsetName

public Charset decodeCharsetName(String name)

Decode a character encoding name found in MSH.18.

Parameters:

name - character set name from MSH.18

Returns:

decoded Charset, or null if unable to decode

Throws:

IllegalArgumentException - if label is null