ca.uhn.hl7v2.preparser

Class XML

java.lang.Object

ca.uhn.hl7v2.preparser.XML

public class XML
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XML.HL7MessageHandler the SAXParser reports parsing events to an object of this class.
protected static class	XML.StopParsingException

Constructor Summary

Constructors

Constructor and Description
XML()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)
static boolean	parseMessage(Properties props, String message, Collection<DatumPath> msgMask) parse message according to our HL7 XML handler, and dump the data found to props.

Methods inherited from class java.lang.Object

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

Constructor Detail

XML

public XML()

Method Detail

parseMessage

public static boolean parseMessage(Properties props,
                                   String message,
                                   Collection<DatumPath> msgMask)
                            throws HL7Exception

parse message according to our HL7 XML handler, and dump the data found to props. returns true if we parsed ok, which means well-formed XML, and that's about it. We just barely check against HL7 structure, and ignore any elements / text that is unexpected (that is, impossible in any HL7 message: independant of any message / segment definitions). "message" should be an XML document with one top-level element -- that being the message. ( or whatever). We're only expecting one message to be in "message". props can be null if you don't want the data (we still parse). The message data found in message (that passes msgMask) will be added to props as key / value pairs with the key a toString() of the appropriate DatumPath for the location where the data is found (i.e. in the ZYX[a]-b[c]-d-e style), and the value the corresponding text. So, after calling parseMessage successfully, if you wanted to retrieve the message data from props you might call something like props.getProperty((new DatumPath()).add("MSH").add(1).toString()) and that would return a String with "|", probably. Note that this package facilitates the extraction of message data in a way independent of message version (i.e. components and whatever getting added): With a message of "fieldy-field-field", "ZYX[0]-1[0]-1-1" will be the key that ends up in props (see notes at DatumPath.toString()) So if you, coding for a future version of the FOO message but recieving old-version message data, tried props.getProperty((new DatumPath()).add("ZYX").add(0).add(42).add(0).add(1).toString()) with the message above (that is, trying to extract a repetition and component that aren't there), you would get "ZYX[0]-42[0]-1-1" mapping to "fieldy-field-field" in the resulting props. If the message was "component data" and you, coding for an old version of this FOO message but recieving new-version FOO message data, tried props.getProperty((new DatumPath()).add("ZYX").add(0).add(42).toString()) you would get "ZYX[0]-42[0]-1-1" mapping to "component data" in the resulting props. msgMask lets you specify which parts of the message you want dumped to props. Passing in null gets you everything. Otherwise, msgMask's elements should all be DatumPaths (! => ClassCastException), and a particular part of the message will be dumped to props only if it's location, as represented by a DatumPath, startsWith (as in DatumPath.startsWith()) at least one element of msgMask. So if one element of msgMask was a (new DatumPath()).add(new String("ZYX")), then everything in all ZYX segment would get dumped to props. A (new DatumPath()).add(new String("ZYX")).add(1) would get only the first repetitions of same (if there is one) dumped to props. etc. etc. Note that a DatumPath of size() == 0 in msgMask will get you everything, no matter what the other elements of msgMask are, because all DatumPaths startsWith the zero-length DatumPath. Segment group elements (eg. ADT_A01.PROCEDURE) are handled fine, but they aren't addressed in msgMask or in the output in props -- basically any element tags at the level immediately inside the message element, and having a name that starts with the message element name + '.', is ignored (meaning it's contents are dealt with the same as if the start and end tags' just wasn't there.)

Throws:

HL7Exception

main

public static void main(String[] args)