Package ca.uhn.hl7v2.parser

Class CustomModelClassFactory

java.lang.Object

ca.uhn.hl7v2.parser.AbstractModelClassFactory

ca.uhn.hl7v2.parser.CustomModelClassFactory

All Implemented Interfaces:

ModelClassFactory, Serializable

public class CustomModelClassFactory
extends AbstractModelClassFactory

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, a delegate ModelClassFactory (by default DefaultModelClassFactory) is used.

Also, a custom event map location is supported (by setting AbstractModelClassFactory.setEventMapDirectory(String) in a way that only new or modified structures needs to be defined there. If no structure was found, the event map of the delegate ModelClassFactory serves as fallback.

Since:

1.0

Author:

Christian Ohr, 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	Description
CustomModelClassFactory()	Constructor which just delegated to DefaultModelClassFactory
CustomModelClassFactory(ModelClassFactory defaultFactory, Map<String,String[]> map)	Set an explicit ModelClassFactory is underlying delegate
CustomModelClassFactory(String packageName)	Constructor
CustomModelClassFactory(Map<String,String[]> map)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addModels(Map<String,String[]> addedModelClasses)	Add model class packages after the object has been instantiated
protected <T> Class<T>	findClass(String subpackage, String name, String version)	Finds appropriate classes to be loaded for the given structure/type
Map<String,String[]>	getCustomModelClasses()	Returns the configured custom model classes
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)
String	getMessageStructureForEvent(String eventName, Version version)	Looks up its own event map.
Class<? extends Segment>	getSegmentClass(String name, String version)
Class<? extends Type>	getTypeClass(String name, String version)

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

getEventMapDirectory, getEventMapForVersion, loadMessageStructures, setEventMapDirectory

Methods inherited from class java.lang.Object

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

Constructor Details

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".

CustomModelClassFactory

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

Set an explicit ModelClassFactory is underlying delegate

Parameters:

defaultFactory - default factory to be delegated to

map - custom model map

Method Details

getMessageClass

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

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

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

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

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 <T> Class<T> findClass(String subpackage,
 String name,
 String version)

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

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)

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

getCustomModelClasses

public Map<String,String[]> getCustomModelClasses()

Returns the configured custom model classes

Returns:

a map of custom model classes

addModels

public void addModels(Map<String,String[]> addedModelClasses)

Add model class packages after the object has been instantiated

Parameters:

addedModelClasses - map with version number as key and package names has value

getMessageStructureForEvent

public String getMessageStructureForEvent(String eventName,
 Version version)
                                   throws HL7Exception

Looks up its own event map. If no structure was found, the call is delegated to the default ModelClassFactory. If nothing can be found, the eventName is returned as structure.

Specified by:

getMessageStructureForEvent in interface ModelClassFactory

Overrides:

getMessageStructureForEvent in class AbstractModelClassFactory

Parameters:

eventName - event name

version - HL7 version

Returns:

message structure name for the eventName and version or null if none could be found

Throws:

HL7Exception - if the version is unknown or the message structure list is inaccessible

See Also:

• AbstractModelClassFactory.getMessageStructureForEvent(java.lang.String, ca.uhn.hl7v2.Version)