hapi-sourcegen:confgen

Full name:

ca.uhn.hapi:hapi-sourcegen:2.2:confgen

Description:

Maven Plugin for generating HAPI message structure classes which are based on an HL7 conformance profile file. For more information on using this plugin, see the Confgen Usage page.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 2.1.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
packageName String 2.1 The package for the generated source, e.g. "com.acme.hl7structure.adt"
profile String 2.1 The conformance profile (XML file path) to use
targetDirectory String 2.1 The target directory for the generated source

Optional Parameters

Name Type Since Description
generateDataTypes String 2.1 Should data types be generated. Valid options are:
  • NONE: Do not generate custom data types, use HAPI's normal data type classes for the HL7 version that the profile corresponds to
  • SINGLE: Generate a single instance of each data type. In this case, hapi will generate a custom data type for the first instance of each type that it finds. So, any customizations that need to be made must be made in the very first time that a particular data type is used within a profile. For example, if you need to customize the "SN" data type, you will need to customize the very first one that appears in the profile, as all SNs within your message type will use the structure generated by the first one.
  • ALL: Generate an individual data type object for each and every instance of a datatype within a structure. Note that this is very powerful and flexible, but also has the potential to generate a large number of classes, so use with caution.

Default value is: NONE.
templatePackage String 2.1 The package from which to load the templates

Parameter Details

generateDataTypes:

Should data types be generated. Valid options are:
  • NONE: Do not generate custom data types, use HAPI's normal data type classes for the HL7 version that the profile corresponds to
  • SINGLE: Generate a single instance of each data type. In this case, hapi will generate a custom data type for the first instance of each type that it finds. So, any customizations that need to be made must be made in the very first time that a particular data type is used within a profile. For example, if you need to customize the "SN" data type, you will need to customize the very first one that appears in the profile, as all SNs within your message type will use the structure generated by the first one.
  • ALL: Generate an individual data type object for each and every instance of a datatype within a structure. Note that this is very powerful and flexible, but also has the potential to generate a large number of classes, so use with caution.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Default: NONE

packageName:

The package for the generated source, e.g. "com.acme.hl7structure.adt"
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes

profile:

The conformance profile (XML file path) to use
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes

targetDirectory:

The target directory for the generated source
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes

templatePackage:

The package from which to load the templates
  • Type: java.lang.String
  • Since: 2.1
  • Required: No