project35.specifications
Class PrintFormDefinitions
java.lang.Object
project35.specifications.FunctionalSpecificationAspect
project35.specifications.PrintFormDefinitions
- All Implemented Interfaces:
- ServiceAspectDescription
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:
- field name
- whether the field is required or not
- the data type (eg: integer, string, list field...)
- constraints which describe restriction on the field values. for
example, an integer field may accept values in the domain [4,20)
These values are gathered from two sources:
- template definitions supplied by the
project35.mda.model.RecordModelFactory
class.
- properties from the
project35.mda.config.SchemaConceptPropertyManager
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.
- Version:
- 1.0
- Author:
- Kevin Garwood (kgarwood@users.sourceforge.net)
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 |
serviceSpecificationUtility
protected PrintServiceSpecification serviceSpecificationUtility
PrintFormDefinitions
public PrintFormDefinitions(Project35ApplicationContext targetSchemaApplicationContext)
getJumpTable
public java.lang.String getJumpTable()
getDescription
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
- Overrides:
getDescription
in class FunctionalSpecificationAspect
generateHTML
public void generateHTML()
- Description copied from class:
FunctionalSpecificationAspect
- generates the HTML for the functional specification aspect.
- Specified by:
generateHTML
in class FunctionalSpecificationAspect
getHelpLink
public java.net.URL getHelpLink(java.lang.String recordClassName,
java.lang.String fieldName)
printPluginConfiguration
protected void printPluginConfiguration(PluginConfiguration pluginConfiguration)