ca.uhn.hl7v2.conf.classes.generator.builders
Class DocumentationBuilder

java.lang.Object
  ca.uhn.hl7v2.conf.classes.generator.builders.DocumentationBuilder

public final class DocumentationBuilder
extends java.lang.Object

This Class contains some of the Documentation for the Class to be generated

Author:

James AgnewPaul BrohmanMitch DelachevrotiereShawn DyckCory Metcalf

Method Summary

void	decorateComponent(GeneratedConformanceContainer genClass, Component comp) Adds a table of comments to a Generated Component Class
void	decorateConformanceMessage(GeneratedConformanceMessage genClass, RuntimeProfile runtimeProfile) Adds a table of comments to a Conformance Message Class
void	decorateConstantValue(GeneratedMethod genMethod) Adds Class Comments to a getMaxLength method
void	decorateConstructor(GeneratedMethod constructor, java.lang.String className) Adds comments to a generated constructor
void	decorateField(GeneratedConformanceContainer genClass, Field field) Adds Class Comments to a Generated Field Class
void	decorateMaxLength(GeneratedMethod genMethod) Adds Class Comments to a getMaxLength method
void	decorateMaxReps(GeneratedMethod genMethod) Adds Class Comments to a Maximum Repition Method
void	decorateMinReps(GeneratedMethod genMethod) Adds Class Comments to a Minimum Repition Method
void	decoratePrimitive(GeneratedPrimitive genClass, AbstractComponent ac) Adds Class Comments to a Generated Primitive Class
void	decorateProfileStructure(GeneratedConformanceContainer genClass, ProfileStructure ps) Adds Class Comments to a Generated Class
void	decorateRepGetter(GeneratedRepGetter genMethod, Field field, java.lang.String repType) Adds Class Comments to a Generated Method
void	decorateRepGetter(GeneratedRepGetter genMethod, ProfileStructure profileStructure, java.lang.String repType) Adds Class Comments to a Generated Method
void	decorateSegGroup(GeneratedConformanceContainer genClass, SegGroup segGroup) Adds Class Comments to a Generated SegGroup Class
void	decorateSegment(GeneratedConformanceContainer genClass, Seg seg) Adds Class Comments to a Generated Segment Class
void	decorateSetValue(GeneratedMethod genMethod, long maxLength)
static DocumentationBuilder	getDocumentationBuilder() Returns the singleton instance of the DocumentationBuilder
java.lang.String	getGeneratedClassHeader() Contains the License agreement for the Generated Classes

Methods inherited from class java.lang.Object

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

Method Detail

getDocumentationBuilder

public static DocumentationBuilder getDocumentationBuilder()

Returns the singleton instance of the DocumentationBuilder

Returns:

the singleton instance of the DocumentationBuilder

decorateComponent

public void decorateComponent(GeneratedConformanceContainer genClass,
                              Component comp)

Adds a table of comments to a Generated Component Class

Parameters:

genClass - a GeneratedConformanceContainer

comp - the component for which the comments are being added to

decorateConformanceMessage

public void decorateConformanceMessage(GeneratedConformanceMessage genClass,
                                       RuntimeProfile runtimeProfile)

Adds a table of comments to a Conformance Message Class

Parameters:

genClass - a GeneratedConformanceMessage

runtimeProfile - the runtimeProfile for which the comments are being added to

decorateConstantValue

public void decorateConstantValue(GeneratedMethod genMethod)

Adds Class Comments to a getMaxLength method

Parameters:

genMethod - the Generated Method to add the constant value comments to

decorateConstructor

public void decorateConstructor(GeneratedMethod constructor,
                                java.lang.String className)

Adds comments to a generated constructor

Parameters:

constructor - a constructor to add comments to

msg - the message

decorateField

public void decorateField(GeneratedConformanceContainer genClass,
                          Field field)

Adds Class Comments to a Generated Field Class

Parameters:

genClass - a GeneratedConformanceContainer

field - the field for which the comments are being added to

decorateMaxLength

public void decorateMaxLength(GeneratedMethod genMethod)

Adds Class Comments to a getMaxLength method

Parameters:

genMethod - a GeneratedMethod

decorateMaxReps

public void decorateMaxReps(GeneratedMethod genMethod)

Adds Class Comments to a Maximum Repition Method

Parameters:

genClass - a GeneratedConformanceContainer

genMethod - the GeneratedMethod for which the comments are being added to

decorateMinReps

public void decorateMinReps(GeneratedMethod genMethod)

Adds Class Comments to a Minimum Repition Method

Parameters:

genClass - a GeneratedConformanceContainer

genMethod - the GeneratedMethod for which the comments are being added to

decoratePrimitive

public void decoratePrimitive(GeneratedPrimitive genClass,
                              AbstractComponent ac)

Adds Class Comments to a Generated Primitive Class

Parameters:

genClass - a GeneratedConformanceContainer

ac - the AbstractComponent for which the comments are being added to

decorateProfileStructure

public void decorateProfileStructure(GeneratedConformanceContainer genClass,
                                     ProfileStructure ps)

Adds Class Comments to a Generated Class

Parameters:

genClass - a GeneratedConformanceContainer

ps - the Profile Structure for which the comments are being added to

decorateRepGetter

public void decorateRepGetter(GeneratedRepGetter genMethod,
                              Field field,
                              java.lang.String repType)

Adds Class Comments to a Generated Method

Parameters:

genMethod - a GeneratedRepGetter

field - the field for which the comments are being added to

repType - the repetition Type

decorateRepGetter

public void decorateRepGetter(GeneratedRepGetter genMethod,
                              ProfileStructure profileStructure,
                              java.lang.String repType)

Adds Class Comments to a Generated Method

Parameters:

genMethod - a GeneratedRepGetter

profileStructure - the Profile Structure for which the comments are being added to

repType - the repetition Type

decorateSegGroup

public void decorateSegGroup(GeneratedConformanceContainer genClass,
                             SegGroup segGroup)

Adds Class Comments to a Generated SegGroup Class

Parameters:

genClass - a GeneratedConformanceContainer

segGroup - the SegGroup for which the comments are being added to

decorateSegment

public void decorateSegment(GeneratedConformanceContainer genClass,
                            Seg seg)

Adds Class Comments to a Generated Segment Class

Parameters:

genClass - a GeneratedConformanceContainer

seg - the Segment for which the comments are being added to

decorateSetValue

public void decorateSetValue(GeneratedMethod genMethod,
                             long maxLength)

getGeneratedClassHeader

public java.lang.String getGeneratedClassHeader()

Contains the License agreement for the Generated Classes

Returns:

Generated Class Lincense agreement