ca.uhn.hl7v2.parser
Class CustomModelClassFactory

java.lang.Object
  ca.uhn.hl7v2.parser.CustomModelClassFactory

All Implemented Interfaces:

ModelClassFactory, Serializable

public class CustomModelClassFactory
extends Object
implements ModelClassFactory

ModelClassFactory which allows custom packages to search to be specified. These packages will be searched first, and if nothing is found for a particular structure, DefaultModelClassFactory is used.

Since:

1.0

Author:

Based on implementation by Christian Ohr, James Agnew

See Also:

Serialized Form

Constructor Summary

CustomModelClassFactory()
Constructor which just delegated to DefaultModelClassFactory

CustomModelClassFactory(Map<String,String[]> map)
Constructor

CustomModelClassFactory(String packageName)
Constructor

Method Summary

protected Class<?>	findClass(String subpackage, String name, String version) Finds appropriate classes to be loaded for the given structure/type
Class<? extends Group>	getGroupClass(String name, String version)
Class<? extends Message>	getMessageClass(String name, String version, boolean isExplicit)
Class<? extends Message>	getMessageClassInASpecificPackage(String theName, String theVersion, boolean theIsExplicit, String thePackageName) Delegates calls to DefaultModelClassFactory.getMessageClassInASpecificPackage(String, String, boolean, String)
Class<? extends Segment>	getSegmentClass(String name, String version)
Class<? extends Type>	getTypeClass(String name, String version)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomModelClassFactory

public CustomModelClassFactory()

Constructor which just delegated to DefaultModelClassFactory

CustomModelClassFactory

public CustomModelClassFactory(String packageName)

Constructor

Parameters:

packageName - The base package name to use.

When searching, package specified here will be appended with .[version].[structure type].

So, for instance, when looking for a v2.5 segment object, if "com.foo" is passed in, HAPI will look in "com.foo.v25.segment.*"

CustomModelClassFactory

public CustomModelClassFactory(Map<String,String[]> map)

Constructor

Parameters:

map - Map of packages to include.

Keys are versions of HL7, e.g. "2.5".

Values are an array of packages to search in for custom model classes. When searching, the package name here will be appended with ".[structure type]". So, for example, to specify a custom message type, you could create the class foo.example.v23.message.ZRM_Z01, and pass in the string "foo.example.v23".

Method Detail

getMessageClass

public Class<? extends Message> getMessageClass(String name,
                                                String version,
                                                boolean isExplicit)
                                         throws HL7Exception

Specified by:

getMessageClass in interface ModelClassFactory

Parameters:

name - name of message

version - HL7 version

isExplicit - 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

getGroupClass

public Class<? extends Group> getGroupClass(String name,
                                            String version)
                                     throws HL7Exception

Specified by:

getGroupClass in interface ModelClassFactory

Parameters:

name - name of group

version - 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 name,
                                                String version)
                                         throws HL7Exception

Specified by:

getSegmentClass in interface ModelClassFactory

Parameters:

name - name of segment

version - 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 name,
                                          String version)
                                   throws HL7Exception

Specified by:

getTypeClass in interface ModelClassFactory

Parameters:

name - name of type

version - 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

findClass

protected Class<?> findClass(String subpackage,
                             String name,
                             String version)
                      throws HL7Exception

Finds appropriate classes to be loaded for the given structure/type

Throws:

HL7Exception

getMessageClassInASpecificPackage

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

Delegates calls to DefaultModelClassFactory.getMessageClassInASpecificPackage(String, String, boolean, String)

Specified by:

getMessageClassInASpecificPackage in interface ModelClassFactory

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)

Throws:

HL7Exception