Skip to content

Fix issue where a GenericMessage cannot be encoded to XML. #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix issue where a GenericMessage cannot be encoded to XML. #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions hapi-base/src/main/java/ca/uhn/hl7v2/parser/DefaultXMLParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ GNU General Public License (the �GPL�), in which case the provisions of the

import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.HapiContext;
import ca.uhn.hl7v2.model.GenericMessage;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.Message;
import ca.uhn.hl7v2.model.Segment;
Expand Down Expand Up @@ -106,6 +107,12 @@ public DefaultXMLParser(ModelClassFactory theFactory) {
public Document encodeDocument(Message source) throws HL7Exception {
String messageClassName = source.getClass().getName();
String messageName = messageClassName.substring(messageClassName.lastIndexOf('.') + 1);

// Handle GenericMessages which will have an errant $ in their class name.
if (source instanceof GenericMessage) {
messageName = messageName.replaceAll("\\$", "");
}

try {
Document doc = XMLUtils.emptyDocument(messageName);
//Element root = doc.createElement(messageName);
Expand Down
33 changes: 32 additions & 1 deletion hapi-test/src/test/java/ca/uhn/hl7v2/parser/XMLParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,15 @@
import java.io.InputStream;
import java.io.InputStreamReader;

import org.junit.Assert;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.w3c.dom.Document;

import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.Version;
import ca.uhn.hl7v2.model.GenericMessage;
import ca.uhn.hl7v2.model.Message;
import ca.uhn.hl7v2.model.Segment;
import ca.uhn.hl7v2.model.Type;
Expand All @@ -31,7 +34,6 @@
import ca.uhn.hl7v2.model.v25.message.OMD_O03;
import ca.uhn.hl7v2.model.v25.message.ORU_R01;
import ca.uhn.hl7v2.model.v25.segment.OBX;
import ca.uhn.hl7v2.model.v251.message.ERP_R09;
import ca.uhn.hl7v2.util.Terser;

/**
Expand Down Expand Up @@ -431,6 +433,35 @@ public void testMessageParseMethodAndEncodeMethodWithEscapes() throws HL7Excepti

}


/**
* <p>
* Attempt to parse a {@link ca.uhn.hl7v2.model.GenericMessage}. These objects have `$` in their class name, ex: `GenericMessage$V21`.
* The {@link DefaultXMLParser} will attempt to use the class name when constructing the {@link Document} when encoding. The `$` is
* not a valid character within an element name.
* </p>
* <p>
* Construct a {@link GenericMessage} for each available version, and call {@link DefaultXMLParser#encode(Message)} on the message.
* We expect that a valid {@link Document} is returned, as the `$` is stripped out.
* </p>
*/
@Test
public void test_encode_GenericMessage() throws Exception {

DefaultXMLParser xmlParser = new DefaultXMLParser();

for (Version version : Version.values()) {

Class<? extends Message> c = GenericMessage.getGenericMessageClass(version.getVersion());
Message m = c.getConstructor(ModelClassFactory.class).newInstance(new GenericModelClassFactory());

Document d = xmlParser.encodeDocument(m);
Assert.assertNotNull(d);
Assert.assertEquals("GenericMessage" + version.name(), d.getDocumentElement().getTagName());
}
}


private String loadFile(String name) throws IOException {
return loadFile(name, '\n');
}
Expand Down