org.hl7.fhir.core/org.hl7.fhir.core.generator
Grahame Grieve d535bbaacb Use packages.fhir.org 2020-02-18 14:31:09 +11:00
..
configuration fix getSecurity 2020-02-13 21:19:04 +11:00
src/org/hl7/fhir/core/generator Use packages.fhir.org 2020-02-18 14:31:09 +11:00
readme.md finish R5 code generator 2019-12-29 09:44:23 +11:00

readme.md

The Java Core Code Generator

Note: This code only generates tje R5 java code. Older generated models are now maintained by hand.

To run this code, run the class JavaCoreGenerator with 3 parameters:

  • 1: fhir version to generate from (e.g. 4.1.0 or 'current'
  • 2: project directory to read configuration and templates from - e.g. C:\work\org.hl7.fhir\org.hl7.fhir.core\org.hl7.fhir.core.generator\configuration
  • 3: project directory to generate code into - e.g. C:\work\org.hl7.fhir\org.hl7.fhir.core\org.hl7.fhir.r5.new

The generation process depends on the code it generates - do not regenerate the master R5 code until you have tested that it generates correctly.

To test the generation:

  • create a new project, copy the existing R5 code into it, and get it compiling
  • make sure that project is not in the build path for the generator itself, which depends on the production R5 code
  • run the generation
  • refresh etc and make sure that the compiler is happy
  • copy the JUnit tests RoundTripTests into the copy project, update the constants, and execute it
  • check all the tests pass, and inspect a sampling of the results for consistency

Configuring the Generation Output

The most common reason to alter the generation is to add additional utility routines/enhanceements to the generated classes. To do this, edit on the one of the templates in the configuration directory - xx.java, where xx is the class name (may include containing class). You may also need to add to the imports in the configuration.ini file.