ca.uhn.hl7v2.util

Class Hl7InputStreamMessageIterator

java.lang.Object

ca.uhn.hl7v2.HapiContextSupport

ca.uhn.hl7v2.util.Hl7InputStreamMessageIterator

All Implemented Interfaces:

Iterator<Message>

public class Hl7InputStreamMessageIterator
extends HapiContextSupport
implements Iterator<Message>

Reads from an InputStream containing a stream of encoded HL7 messages and iterates over those messages. This class is geared towards reading from files, and tries to be very lenient about the format of the stream, specifically concerning control characters and line endings. It should be safe to provide a stream containing Windows or Unix line endings (which will be treated as segment delimiters). It is also safe to provide a stream containing MLLP control blocks before and after each message (although these will not be validated! Do not use this class to read MLLP messages from a socket stream!)

The input stream could, for example, be a FileInputStream reading from a text file containing a number of HL7 messages in plain text format.

Usage note: If an IOException occurs while reading from the stream or a message parsing exception occurs, it will be thrown as an unchecked Hl7InputStreamMessageStringIterator.ParseFailureError

Constructor Summary

Constructors

Constructor and Description
Hl7InputStreamMessageIterator(InputStream theInputStream) Constructor
Hl7InputStreamMessageIterator(InputStream theInputStream, HapiContext theHapiContext) Constructor
Hl7InputStreamMessageIterator(Reader theReader) Constructor
Hl7InputStreamMessageIterator(Reader theReader, HapiContext theHapiContext) Constructor

Method Summary

Modifier and Type	Method and Description
static Hl7InputStreamMessageIterator	getForClasspathResource(String theClasspath) Factory method which returns an instance which reads from a file on the classpath
boolean	hasNext()
Message	next()
void	remove() Unsupported method!
void	setIgnoreComments(boolean theIgnoreComments) If set to true, any lines beginning with a hash (#) will be ignored.
void	setMessageType(Class<? extends Message> theMessageType) If set (default is null), all messages will be parsed into instances of this type.

Methods inherited from class ca.uhn.hl7v2.HapiContextSupport

getHapiContext, setHapiContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

Hl7InputStreamMessageIterator

public Hl7InputStreamMessageIterator(InputStream theInputStream)

Constructor

Parameters:

theInputStream - The input stream to read from

Hl7InputStreamMessageIterator

public Hl7InputStreamMessageIterator(Reader theReader)

Constructor

Parameters:

theReader - The reader to read from

Hl7InputStreamMessageIterator

public Hl7InputStreamMessageIterator(InputStream theInputStream,
                                     HapiContext theHapiContext)

Constructor

Parameters:

theInputStream - The input stream to read from

theHapiContext - The HapiContext from which to obtain the parser

Hl7InputStreamMessageIterator

public Hl7InputStreamMessageIterator(Reader theReader,
                                     HapiContext theHapiContext)

Constructor

Parameters:

theReader - The reader to read from

theHapiContext - The HapiContext from which to obtain the parser

Method Detail

getForClasspathResource

public static Hl7InputStreamMessageIterator getForClasspathResource(String theClasspath)

Factory method which returns an instance which reads from a file on the classpath

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Message>

next

public Message next()

Specified by:

next in interface Iterator<Message>

remove

public void remove()

Unsupported method!

Specified by:

remove in interface Iterator<Message>

Throws:

UnsupportedOperationException - If called

setIgnoreComments

public void setIgnoreComments(boolean theIgnoreComments)

If set to true, any lines beginning with a hash (#) will be ignored. This allows you to place comments in a file to be read if needed.

setMessageType

public void setMessageType(Class<? extends Message> theMessageType)

If set (default is null), all messages will be parsed into instances of this type.