ca.uhn.hl7v2.parser.DefaultXMLParser Maven / Gradle / Ivy
/**
The contents of this file are subject to the Mozilla Public License Version 1.1
(the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.mozilla.org/MPL/
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
specific language governing rights and limitations under the License.
The Initial Developer of the Original Code is University Health Network. Copyright (C)
2001. All Rights Reserved.
Contributor(s): ______________________________________.
Alternatively, the contents of this file may be used under the terms of the
GNU General Public License (the �GPL�), in which case the provisions of the GPL are
applicable instead of those above. If you wish to allow use of your version of this
file only under the terms of the GPL and not to allow others to use your version
of this file under the MPL, indicate your decision by deleting the provisions above
and replace them with the notice and other provisions required by the GPL License.
If you do not delete the provisions above, a recipient may use your version of
this file under either the MPL or the GPL.
*/
package ca.uhn.hl7v2.parser;
import java.io.File;
import java.io.FileReader;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.HapiContext;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.Message;
import ca.uhn.hl7v2.model.Segment;
import ca.uhn.hl7v2.model.Structure;
import ca.uhn.hl7v2.util.XMLUtils;
import ca.uhn.hl7v2.validation.impl.NoValidation;
import ca.uhn.hl7v2.validation.impl.ValidationContextFactory;
/**
* A default XMLParser. This class assigns segment elements (in an XML-encoded message)
* to Segment objects (in a Message object) using the name of a segment and the names
* of any groups in which the segment is nested. The names of group classes must correspond
* to the names of group elements (they must be identical except that a dot in the element
* name, following the message name, is replaced with an underscore, in order to consitute a
* valid class name).
* At the time of writing, the group names in the XML spec are changing. Many of the group
* names have been automatically generated based on the group contents. However, these automatic
* names are gradually being replaced with manually assigned names. This process is expected to
* be complete by November 2002. As a result, mismatches are likely. Messages could be
* transformed prior to parsing (using XSLT) as a work-around. Alternatively the group class names
* could be changed to reflect updates in the XML spec. Ultimately, HAPI group classes will be
* changed to correspond with the official group names, once these are all assigned.
*
* @see ParserConfiguration for configuration options which may affect parser encoding and decoding behaviour
* @author Bryan Tripp
*/
public class DefaultXMLParser extends XMLParser {
private static final Logger log = LoggerFactory.getLogger(DefaultXMLParser.class);
private static final Set ourForceGroupNames;
static {
ourForceGroupNames = new HashSet();
ourForceGroupNames.add("DIET");
}
public DefaultXMLParser() {
super();
}
public DefaultXMLParser(HapiContext context) {
super(context);
}
/**
* Creates a new instance of DefaultXMLParser
*
* @param theFactory custom factory to use for model class lookup
*/
public DefaultXMLParser(ModelClassFactory theFactory) {
super(theFactory);
}
/**
* Creates an XML Document that corresponds to the given Message object.
* If you are implementing this method, you should create an XML Document, and insert XML Elements
* into it that correspond to the groups and segments that belong to the message type that your subclass
* of XMLParser supports. Then, for each segment in the message, call the method
* encode(Segment segmentObject, Element segmentElement) using the Element for
* that segment and the corresponding Segment object from the given Message.
*/
public Document encodeDocument(Message source) throws HL7Exception {
String messageClassName = source.getClass().getName();
String messageName = messageClassName.substring(messageClassName.lastIndexOf('.') + 1);
try {
Document doc = XMLUtils.emptyDocument(messageName);
//Element root = doc.createElement(messageName);
//doc.appendChild(root);
encode(source, doc.getDocumentElement());
return doc;
} catch (Exception e) {
throw new HL7Exception(
"Can't create XML document - " + e.getClass().getName(), e);
}
}
/**
* Copies data from a group object into the corresponding group element, creating any
* necessary child nodes.
*/
private void encode(Group groupObject, Element groupElement) throws HL7Exception {
String[] childNames = groupObject.getNames();
String messageName = groupObject.getMessage().getName();
try {
for (String name : childNames) {
Structure[] reps = groupObject.getAll(name);
for (Structure rep : reps) {
String elementName = makeGroupElementName(messageName, name);
Element childElement;
try {
childElement = groupElement.getOwnerDocument().createElement(elementName);
} catch (DOMException e) {
throw new HL7Exception(
"Can't encode element " + elementName + " in group " + groupObject.getClass().getName(), e);
}
groupElement.appendChild(childElement);
if (rep instanceof Group) {
encode((Group) rep, childElement);
}
else if (rep instanceof Segment) {
encode((Segment) rep, childElement);
}
}
}
} catch (DOMException e) {
throw new HL7Exception(
"Can't encode group " + groupObject.getClass().getName(), e);
}
}
/**
* Creates and populates a Message object from an XML Document that contains an XML-encoded HL7 message.
* The easiest way to implement this method for a particular message structure is as follows:
*
- Create an instance of the Message type you are going to handle with your subclass
* of XMLParser
* - Go through the given Document and find the Elements that represent the top level of
* each message segment.
* - For each of these segments, call
parse(Segment segmentObject, Element segmentElement),
* providing the appropriate Segment from your Message object, and the corresponding Element.
* At the end of this process, your Message object should be populated with data from the XML
* Document.
* @throws HL7Exception if the message is not correctly formatted.
* @throws EncodingNotSupportedException if the message encoded
* is not supported by this parser.
*/
public Message parseDocument(Document xmlMessage, String version) throws HL7Exception {
assertNamespaceURI(xmlMessage.getDocumentElement().getNamespaceURI());
Message message = instantiateMessage(xmlMessage.getDocumentElement().getLocalName(), version, true);
// Note: this will change in future to reuse the Parser's/HapiContext's
// ValidationContext.
message.setValidationContext(getValidationContext());
parse(message, xmlMessage.getDocumentElement());
return message;
}
/**
* Populates the given group object with data from the given group element, ignoring
* any unrecognized nodes.
*/
private void parse(Group groupObject, Element groupElement) throws HL7Exception {
String[] childNames = groupObject.getNames();
String messageName = groupObject.getMessage().getName();
NodeList allChildNodes = groupElement.getChildNodes();
List unparsedElementList = new ArrayList();
for (int i = 0; i < allChildNodes.getLength(); i++) {
Node node = allChildNodes.item(i);
String name = node.getLocalName();
if (node.getNodeType() == Node.ELEMENT_NODE && !unparsedElementList.contains(name)) {
assertNamespaceURI(node.getNamespaceURI());
unparsedElementList.add(name);
}
}
//we're not too fussy about order here (all occurrences get parsed as repetitions) ...
for (String nextChildName : childNames) {
String childName = nextChildName;
if(groupObject.isGroup(nextChildName)) {
childName = makeGroupElementName(groupObject.getMessage().getName(), nextChildName);
}
unparsedElementList.remove(childName);
// 4 char segment names are second occurrences of a segment within a single message
// structure. e.g. the second PID segment in an A17 patient swap message is known
// to hapi's code represenation as PID2
if (nextChildName.length() == 4 && Character.isDigit(nextChildName.charAt(3))) {
log.trace("Skipping rep segment: {}", nextChildName);
} else {
parseReps(groupElement, groupObject, messageName, nextChildName, nextChildName);
}
}
for (String segName : unparsedElementList) {
String segIndexName = groupObject.addNonstandardSegment(segName);
parseReps(groupElement, groupObject, messageName, segName, segIndexName);
}
}
//param childIndexName may have an integer on the end if >1 sibling with same name (e.g. NTE2)
private void parseReps(Element groupElement, Group groupObject,
String messageName, String childName, String childIndexName) throws HL7Exception {
String groupName = makeGroupElementName(messageName, childName);
List reps = getChildElementsByTagName(groupElement, groupName);
log.trace("# of elements matching {}: {}", groupName, reps.size());
if (groupObject.isRepeating(childIndexName)) {
for (int i = 0; i < reps.size(); i++) {
parseRep(reps.get(i), groupObject.get(childIndexName, i));
}
} else {
if (reps.size() > 0) {
parseRep(reps.get(0), groupObject.get(childIndexName, 0));
}
// if (reps.size() > 1) {
// String newIndexName = groupObject.addNonstandardSegment(childName);
// for (int i = 1; i < reps.size(); i++) {
// parseRep((Element) reps.get(i), groupObject.get(newIndexName, i-1));
// }
// }
if (reps.size() > 1) {
String newIndexName;
int i=1;
try {
for (i = 1; i < reps.size(); i++) {
newIndexName = childName+(i+1);
Structure st = groupObject.get(newIndexName);
parseRep(reps.get(i), st);
}
} catch(Throwable t) {
log.info("Issue Parsing: " + t);
newIndexName = groupObject.addNonstandardSegment(childName);
for (int j = i; j < reps.size(); j++) {
parseRep(reps.get(j), groupObject.get(newIndexName, j-i));
}
}
}
}
}
private void parseRep(Element theElem, Structure theObj) throws HL7Exception {
if (theObj instanceof Group) {
parse((Group) theObj, theElem);
}
else if (theObj instanceof Segment) {
parse((Segment) theObj, theElem);
}
log.trace("Parsed element: {}", theElem.getNodeName());
}
//includes direct children only
private List getChildElementsByTagName(Element theElement, String theName) throws HL7Exception {
List result = new ArrayList(10);
NodeList children = theElement.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node child = children.item(i);
if (child.getNodeType() == Node.ELEMENT_NODE && child.getLocalName().equals(theName)) {
assertNamespaceURI(child.getNamespaceURI());
result.add((Element)child);
}
}
return result;
}
/**
* Given the name of a group element in an XML message, returns the corresponding
* group class name. This name is identical except in order to be a valid class
* name, the dot character immediately following the message name is replaced with
* an underscore. For example, there is a group element called ADT_A01.INSURANCE and the
* corresponding group Class is called ADT_A01_INSURANCE.
*/
// protected static String makeGroupClassName(String elementName) {
// return elementName.replace('.', '_');
// }
/**
* Given the name of a message and a Group class, returns the corresponding group element name in an
* XML-encoded message. This is the message name and group name separated by a dot. For example,
* ADT_A01.INSURANCE.
*
* If it looks like a segment name (i.e. has 3 characters), no change is made.
*/
protected static String makeGroupElementName(String messageName, String className) {
String ret;
if (className.length() > 4 || ourForceGroupNames.contains(className)) {
StringBuilder elementName = new StringBuilder();
elementName.append(messageName);
elementName.append('.');
elementName.append(className);
ret = elementName.toString();
} else if (className.length() == 4) {
// It is not clear why this case is needed.. We should figure out
// why it was added, since removing it or optimizing its use would
// prevent the need for "ourForGroupNames" above
ret = className.substring(0,3);
} else {
ret = className;
}
return ret;
}
/** Test harness */
public static void main(String args[]) {
if (args.length != 1) {
System.out.println("Usage: DefaultXMLParser pipe_encoded_file");
System.exit(1);
}
//read and parse message from file
try {
File messageFile = new File(args[0]);
long fileLength = messageFile.length();
FileReader r = new FileReader(messageFile);
char[] cbuf = new char[(int) fileLength];
System.out.println("Reading message file ... " + r.read(cbuf) + " of " + fileLength + " chars");
r.close();
String messString = String.valueOf(cbuf);
Parser inParser = null;
Parser outParser = null;
PipeParser pp = new PipeParser();
ca.uhn.hl7v2.parser.XMLParser xp = new DefaultXMLParser();
System.out.println("Encoding: " + pp.getEncoding(messString));
if (pp.getEncoding(messString) != null) {
inParser = pp;
outParser = xp;
}
else if (xp.getEncoding(messString) != null) {
inParser = xp;
outParser = pp;
}
Message mess = inParser.parse(messString);
System.out.println("Got message of type " + mess.getClass().getName());
String otherEncoding = outParser.encode(mess);
System.out.println(otherEncoding);
}
catch (Exception e) {
e.printStackTrace();
}
}
/**
* {@inheritDoc}
*/
@Override
public void parse(Message theMessage, String theString) throws HL7Exception {
Document doc = parseStringIntoDocument(theString);
parse(theMessage, doc.getDocumentElement());
applySuperStructureName(theMessage);
}
/**
* Convenience factory method which returns an instance that has a
* {@link NoValidation NoValidation validation context}.
*/
public static DefaultXMLParser getInstanceWithNoValidation() {
DefaultXMLParser retVal = new DefaultXMLParser();
retVal.setValidationContext(ValidationContextFactory.noValidation());
return retVal;
}
}