ca.uhn.hl7v2.parser

Class GenericModelClassFactory

java.lang.Object

ca.uhn.hl7v2.parser.AbstractModelClassFactory

ca.uhn.hl7v2.parser.GenericModelClassFactory

All Implemented Interfaces:

ModelClassFactory, Serializable

public class GenericModelClassFactory
extends AbstractModelClassFactory

GenericModelClassFactory is a ModelClassFactory implementation which always returns generic types:

• GenericMessage
• GenericSegment
• GenericGroup

This can be used to run HAPI without any structure JARs, as the generic MCF has no structure dependencies. See the using multiple versions example for more information.

In combination with ParserConfiguration.setAllowUnknownVersions(boolean), the GenericModelClassFactory can be used to parse future versions of HL7 for which HAPI has no support.

Author:

James Agnew

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.parser.AbstractModelClassFactory

DEFAULT_EVENT_MAP_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
GenericModelClassFactory()

Method Summary

Modifier and Type	Method and Description
Class<? extends Group>	getGroupClass(String theName, String theVersion)
Class<? extends Message>	getMessageClass(String theName, String theVersion, boolean theIsExplicit)
Class<? extends Message>	getMessageClassInASpecificPackage(String theName, String theVersion, boolean theIsExplicit, String thePackageName) Retrieves a message class by looking in a specific java package for the message type.
Class<? extends Segment>	getSegmentClass(String theName, String theVersion)
Class<? extends Type>	getTypeClass(String theName, String theVersion)

Methods inherited from class ca.uhn.hl7v2.parser.AbstractModelClassFactory

getEventMapDirectory, getEventMapForVersion, getMessageStructureForEvent, loadMessageStructures, setEventMapDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericModelClassFactory

public GenericModelClassFactory()

Method Detail

getMessageClass

public Class<? extends Message> getMessageClass(String theName,
                                                String theVersion,
                                                boolean theIsExplicit)
                                         throws HL7Exception

Parameters:

theName - name of message

theVersion - HL7 version

theIsExplicit - true if the structure was specified explicitly in MSH-9-3, false if it was inferred from MSH-9-1 and MSH-9-2. If false, a lookup may be performed to find an alternate structure corresponding to that message type and event.

Returns:

a class that implements the specified message

Throws:

HL7Exception - if the version if not recognized or an appropriate class can not be found

getMessageClassInASpecificPackage

public Class<? extends Message> getMessageClassInASpecificPackage(String theName,
                                                                  String theVersion,
                                                                  boolean theIsExplicit,
                                                                  String thePackageName)
                                                           throws HL7Exception

Retrieves a message class by looking in a specific java package for the message type.

Parameters:

theName - The message structure type (e.g. "ADT_A01")

theVersion - The HL7 version (e.g. "2.3.1")

theIsExplicit - If false, the message structure is looked up using Parser.getMessageStructureForEvent(String, String) and converted to the appropriate structure type. For example, "ADT_A04" would be converted to "ADT_A01" because the A04 trigger uses the A01 message structure according to HL7.

thePackageName - The package name to use. Note that if the message type can't be found in this package, HAPI will return the standard type returned by ModelClassFactory.getMessageClass(String, String, boolean)

Returns:

message class

Throws:

HL7Exception

getGroupClass

public Class<? extends Group> getGroupClass(String theName,
                                            String theVersion)
                                     throws HL7Exception

Parameters:

theName - name of group

theVersion - HL7 version

Returns:

a class that implements the specified group

Throws:

HL7Exception - if the version if not recognized or an appropriate class can not be found

getSegmentClass

public Class<? extends Segment> getSegmentClass(String theName,
                                                String theVersion)
                                         throws HL7Exception

Parameters:

theName - name of segment

theVersion - HL7 version

Returns:

a class that implements the specified segment

Throws:

HL7Exception - if the version if not recognized or an appropriate class can not be found

getTypeClass

public Class<? extends Type> getTypeClass(String theName,
                                          String theVersion)
                                   throws HL7Exception

Parameters:

theName - name of type

theVersion - HL7 version

Returns:

a class that implements the specified type

Throws:

HL7Exception - if the version if not recognized or an appropriate class can not be found