Class PrintFormDefinitions

  extended by project35.specifications.FunctionalSpecificationAspect
      extended by project35.specifications.PrintFormDefinitions
All Implemented Interfaces:

public class PrintFormDefinitions
extends FunctionalSpecificationAspect

This generates the part of the functional specification that prints the properties of records and fields defined in the XML schema. The properties of a data form correspond to the properties of a record structure in the XML schema. For the functional specification, the class will print the record class name, and a table that displays the properties of edit, attribute and list fields.

Each row in the table of field descriptions shows the following information:

These values are gathered from two sources:

For each form, the class also prints record level and field level services.

Copyright (c) 2008 Kevin Garwood for Project35. This code is licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Kevin Garwood (

Field Summary
protected  PrintServiceSpecification serviceSpecificationUtility
Fields inherited from class project35.specifications.FunctionalSpecificationAspect
columnValues, documentHeaderUtility, mainBodyBuffer
Constructor Summary
PrintFormDefinitions(Project35ApplicationContext targetSchemaApplicationContext)
Method Summary
 void generateHTML()
          generates the HTML for the functional specification aspect.
 java.lang.String getDescription()
          provides the HTML text that was created through the generateHTML() method. getHelpLink(java.lang.String recordClassName, java.lang.String fieldName)
 java.lang.String getJumpTable()
protected  void printPluginConfiguration(PluginConfiguration pluginConfiguration)
Methods inherited from class project35.specifications.FunctionalSpecificationAspect
addColumnColourValue, addColumnHeader, addColumnValue, addYesNoColumnValue, beginColumnValue, beginParagraph, beginRow, beginTable, endColumnValue, endParagraph, endRow, endTable, getBulletedList, getHyperLinkText, getJumpLinkTable, printBackToTop, printBoldHeading, printBulletedList, printBulletedList, printEnumeratedList, printField, printField, printHeading, printHorizontalLine, printHyperLink, printHyperLink, printParagraphSeparator, printParagraphText, replaceSpacesWithUnderscores, setSectionNumber
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail


protected PrintServiceSpecification serviceSpecificationUtility
Constructor Detail


public PrintFormDefinitions(Project35ApplicationContext targetSchemaApplicationContext)
Method Detail


public java.lang.String getJumpTable()


public java.lang.String getDescription()
Description copied from class: FunctionalSpecificationAspect
provides the HTML text that was created through the generateHTML() method.

Specified by:
getDescription in interface ServiceAspectDescription
getDescription in class FunctionalSpecificationAspect


public void generateHTML()
Description copied from class: FunctionalSpecificationAspect
generates the HTML for the functional specification aspect.

Specified by:
generateHTML in class FunctionalSpecificationAspect


public getHelpLink(java.lang.String recordClassName,
                                java.lang.String fieldName)


protected void printPluginConfiguration(PluginConfiguration pluginConfiguration)