ca.uhn.hl7v2.model.AbstractMessage 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 Original Code is "AbstractMessage.java". Description:
"A default implementation of Message"
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.model;
import java.io.IOException;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import ca.uhn.hl7v2.AcknowledgmentCode;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.Location;
import ca.uhn.hl7v2.Version;
import ca.uhn.hl7v2.model.primitive.CommonTS;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.Parser;
import ca.uhn.hl7v2.parser.PipeParser;
import ca.uhn.hl7v2.util.ArrayUtil;
import ca.uhn.hl7v2.util.ReflectionUtil;
import ca.uhn.hl7v2.util.StringUtil;
import ca.uhn.hl7v2.util.Terser;
import ca.uhn.hl7v2.validation.ValidationContext;
/**
* A default implementation of Message.
* @author Bryan Tripp ([email protected])
*/
@SuppressWarnings("serial")
public abstract class AbstractMessage extends AbstractGroup implements Message {
private static final Pattern ourVersionPattern = Pattern.compile("\\.(v2[0-9][0-9]?)\\.");
private String myVersion;
private transient Parser myParser;
/**
* @param theFactory factory for model classes (e.g. group, segment) for this message
*/
public AbstractMessage(ModelClassFactory theFactory) {
super(null, theFactory);
}
/**
* Returns this Message object.
*/
public Message getMessage() {
return this;
}
public Group getParent() {
return this;
}
/**
* Returns the version number. This default implementation inspects
* this.getClass().getName(). This should be overridden if you are putting
* a custom message definition in your own package, or it will default.
* @see Message#getVersion()
*
* @return lowest available version if not obvious from package name
*/
public String getVersion() {
if (myVersion != null) {
return myVersion;
}
String version = null;
Pattern p = ourVersionPattern;
Matcher m = p.matcher(this.getClass().getName());
if (m.find()) {
String verFolder = m.group(1);
if (verFolder.length() > 0) {
char[] chars = verFolder.toCharArray();
StringBuilder buf = new StringBuilder();
for (int i = 1; i < chars.length; i++) { //start at 1 to avoid the 'v'
buf.append(chars[i]);
if (i < chars.length - 1) buf.append('.');
}
version = buf.toString();
}
}
if (version == null)
version = Version.lowestAvailableVersion().getVersion();
myVersion = version;
return version;
}
/**
* Returns the set of validation rules that applied to this message. If the parser
* was set to "not-validating", this method returns null
*
* @return the set of validation rules that applied to this message
*/
public ValidationContext getValidationContext() {
if (getParser() == null || !getParser().getParserConfiguration().isValidating()) return null;
return getParser().getHapiContext().getValidationContext();
}
/**
* {@inheritDoc }
*/
public Character getFieldSeparatorValue() throws HL7Exception {
Segment firstSegment = (Segment) get(getNames()[0]);
Primitive value = (Primitive) firstSegment.getField(1, 0);
String valueString = value.getValue();
if (valueString == null || valueString.length() == 0) {
return null;
}
return valueString.charAt(0);
}
/**
* {@inheritDoc }
*/
public String getEncodingCharactersValue() throws HL7Exception {
Segment firstSegment = (Segment) get(getNames()[0]);
Primitive value = (Primitive) firstSegment.getField(2, 0);
return value.getValue();
}
/**
* Sets the parser to be used when parse/encode methods are called on this
* Message, as well as its children. It is recommended that if these methods
* are going to be called, a parser be supplied with the validation context
* wanted. Where possible, the parser should be reused for best performance,
* unless thread safety is an issue.
*
* Note that not all parsers can be used. As of version 1.0, only {@link PipeParser}
* supports this functionality
*
* Serialization note: The message parser is marked as transient, so it will not
* survive serialization.
*/
public void setParser(Parser parser) {
if (parser == null) {
throw new NullPointerException("Value may not be null");
}
myParser = parser;
}
/**
* Returns the parser to be used when parse/encode methods are called on this
* Message, as well as its children. The default value is a new {@link PipeParser}.
*
* Serialization note: The message parser is marked as transient, so it will not
* survive serialization.
*/
public Parser getParser() {
if (myParser == null) {
myParser = new PipeParser();
}
return myParser;
}
/**
* {@inheritDoc }
*/
public void parse(String string) throws HL7Exception {
clear();
getParser().parse(this, string);
}
/**
* {@inheritDoc }
*/
public String encode() throws HL7Exception {
return getParser().encode(this);
}
/**
* {@inheritDoc }
*/
public Message generateACK() throws HL7Exception, IOException {
return generateACK(AcknowledgmentCode.AA, null);
}
/**
* {@inheritDoc }
* @deprecated
*/
public Message generateACK(String theAcknowledgementCode, HL7Exception theException) throws HL7Exception, IOException {
AcknowledgmentCode theCode = theAcknowledgementCode == null ?
AcknowledgmentCode.AA :
AcknowledgmentCode.valueOf(theAcknowledgementCode);
return generateACK(theCode, theException);
}
/**
* {@inheritDoc }
*/
public Message generateACK(AcknowledgmentCode theAcknowledgementCode, HL7Exception theException) throws HL7Exception, IOException {
if (theException != null && theException.getResponseMessage() != null) {
return theException.getResponseMessage();
}
Message out = instantiateACK();
out.setParser(getParser());
fillResponseHeader(out, theAcknowledgementCode);
if (theException != null) {
theException.populateResponse(out, theAcknowledgementCode, 0);
}
return out;
}
private Message instantiateACK() throws HL7Exception {
ModelClassFactory mcf = getParser() != null ?
getParser().getFactory() :
new DefaultModelClassFactory();
Version version = Version.versionOf(getVersion());
Message out = null;
if (version != null && version.available()) {
Class clazz = mcf.getMessageClass("ACK", version.getVersion(), false);
if (clazz != null) {
out = ReflectionUtil.instantiateMessage(clazz, mcf);
}
}
if (out == null) {
out = new GenericMessage.UnknownVersion(mcf);
}
if (out instanceof GenericMessage) {
if (!ArrayUtil.contains(out.getNames(), "MSA")) {
out.addNonstandardSegment("MSA");
}
if (!ArrayUtil.contains(out.getNames(), "ERR")) {
out.addNonstandardSegment("ERR");
}
}
return out;
}
/**
* Populates certain required fields in a response message header, using
* information from the corresponding inbound message. The current time is
* used for the message time field, and MessageIDGenerator is
* used to create a unique message ID. Version and message type fields are
* not populated.
*
* @param out outgoing message to be populated
* @param code acknowledgment code
* @return outgoing message
* @throws HL7Exception if header cannot be filled
* @throws IOException if message ID could not be generated
*/
public Message fillResponseHeader(Message out, AcknowledgmentCode code)
throws HL7Exception, IOException {
Segment mshIn = (Segment) get("MSH");
Segment mshOut = (Segment) out.get("MSH");
// get MSH data from incoming message ...
String fieldSep = Terser.get(mshIn, 1, 0, 1, 1);
String encChars = Terser.get(mshIn, 2, 0, 1, 1);
String procID = Terser.get(mshIn, 11, 0, 1, 1);
// populate outbound MSH using data from inbound message ...
Terser.set(mshOut, 1, 0, 1, 1, fieldSep);
Terser.set(mshOut, 2, 0, 1, 1, encChars);
GregorianCalendar now = new GregorianCalendar();
now.setTime(new Date());
Terser.set(mshOut, 7, 0, 1, 1, CommonTS.toHl7TSFormat(now));
Terser.set(mshOut, 9, 0, 1, 1, "ACK");
Terser.set(mshOut, 9, 0, 2, 1, Terser.get(mshIn, 9, 0, 2, 1));
String v = mshOut.getMessage().getVersion();
if (v != null) {
Version version = Version.versionOf(v);
if (version != null && !Version.V25.isGreaterThan(version)) {
Terser.set(mshOut, 9, 0, 3, 1, "ACK");
}
}
Terser.set(mshOut, 10, 0, 1, 1, mshIn.getMessage().getParser().getParserConfiguration().getIdGenerator().getID());
Terser.set(mshOut, 11, 0, 1, 1, procID);
String versionId = Terser.get(mshIn, 12, 0, 1, 1);
if (StringUtil.isBlank(versionId)) {
versionId = Version.highestAvailableVersionOrDefault().getVersion();
}
Terser.set(mshOut, 12, 0, 1, 1, versionId);
// revert sender and receiver
Terser.set(mshOut, 3, 0, 1, 1, Terser.get(mshIn, 5, 0, 1, 1));
Terser.set(mshOut, 4, 0, 1, 1, Terser.get(mshIn, 6, 0, 1, 1));
Terser.set(mshOut, 5, 0, 1, 1, Terser.get(mshIn, 3, 0, 1, 1));
Terser.set(mshOut, 6, 0, 1, 1, Terser.get(mshIn, 4, 0, 1, 1));
// fill MSA for the happy case
Segment msaOut = (Segment) out.get("MSA");
Terser.set(msaOut, 1, 0, 1, 1, code.name());
Terser.set(msaOut, 2, 0, 1, 1, Terser.get(mshIn, 10, 0, 1, 1));
return out;
}
/**
* Provides an overview of the type and structure of this message
*/
@Override
public String toString() {
try {
return encode();
} catch (HL7Exception e) {
return (getClass().getName() + " - Failed to create toString(): " + e.getMessage());
}
}
/**
* {@inheritDoc}
*/
public String printStructure() throws HL7Exception {
StringBuilder builder = new StringBuilder();
appendStructureDescription(builder, 0, false, false, true, true, true);
return builder.toString();
}
/**
* Prints the message structure in a similar way to {@link #printStructure()} but
* optionally excludes elements with no contents.
*/
public String printStructure(boolean includeEmptyElements) throws HL7Exception {
StringBuilder builder = new StringBuilder();
appendStructureDescription(builder, 0, false, false, true, true, includeEmptyElements);
return builder.toString();
}
/**
* Quickly initializes this message with common values in the first (MSH) segment.
*
*
* Settings include:
*
* - MSH-1 (Field Separator) is set to "|"
* - MSH-2 (Encoding Characters) is set to "^~\&"
* - MSH-7 (Date/Time of Message) is set to current time
* - MSH-10 (Control ID) is populated using next value generated by a
* {@link ca.uhn.hl7v2.util.idgenerator.IDGenerator IDGenerator}
*
*
*
* @param messageCode The message code (aka message type) to insert into MSH-9-1. Example: "ADT"
* @param messageTriggerEvent The message trigger event to insert into MSG-9-2. Example: "A01"
* @param processingId The message processing ID to insert into MSH-11. Examples: "T" (for TEST) or "P" for (PRODUCTION)
*
* @throws IOException If the message ID generation fails for some reason
* @throws HL7Exception If the message rejects any of the values which are generated to setting
*/
public void initQuickstart(String messageCode, String messageTriggerEvent, String processingId) throws HL7Exception, IOException {
Segment msh = (Segment) get("MSH");
Version version = Version.versionOf(getVersion());
Terser.set(msh, 1, 0, 1, 1, "|");
Terser.set(msh, 2, 0, 1, 1, Version.V27.isGreaterThan(version) ?
"^~\\&" : "^~\\&#");
GregorianCalendar now = new GregorianCalendar();
Terser.set(msh, 7, 0, 1, 1, CommonTS.toHl7TSFormat(now));
Terser.set(msh, 9, 0, 1, 1, messageCode);
Terser.set(msh, 9, 0, 2, 1, messageTriggerEvent);
Terser.set(msh, 10, 0, 1, 1, getParser().getParserConfiguration().getIdGenerator().getID());
Terser.set(msh, 11, 0, 1, 1, processingId);
Terser.set(msh, 12, 0, 1, 1, getVersion());
// Add structure information if version is 2.4 or better
if (!Version.V24.isGreaterThan(version)) {
if (this instanceof SuperStructure) {
Map eventMap = new DefaultModelClassFactory().getEventMapForVersion(version);
if (StringUtil.isNotBlank(messageCode) && StringUtil.isNotBlank(messageTriggerEvent)) {
String structure = eventMap.get(messageCode + "_" + messageTriggerEvent);
Terser.set(msh, 9, 0, 3, 1, structure);
}
} else {
String className = getClass().getName();
int lastIndexOf = className.lastIndexOf('.');
className = className.substring(lastIndexOf + 1);
if (className.matches("[A-Z]{3}_[A-Z0-9]{3}")) {
Terser.set(msh, 9, 0, 3, 1, className);
}
}
}
}
@Override
public boolean accept(MessageVisitor visitor, Location location) throws HL7Exception {
if (visitor.start(this)) {
visitNestedStructures(visitor, location);
}
return visitor.end(this);
}
}