project35.specifications
Class FunctionalSpecificationAspect

java.lang.Object
  extended by project35.specifications.FunctionalSpecificationAspect
All Implemented Interfaces:
ServiceAspectDescription
Direct Known Subclasses:
PrintDocumentLevelValidationServices, PrintFormDefinitions, PrintGeneralProperties, PrintMenuPlugins, PrintServiceSpecification

public abstract class FunctionalSpecificationAspect
extends java.lang.Object
implements ServiceAspectDescription

this is a base class for other classes that generate sections of a functional specification. It contains many convenience methods that help hide html code from other classes.


Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. 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)

Field Summary
protected  java.util.ArrayList columnValues
           
protected  DocumentHeaderUtility documentHeaderUtility
           
protected  java.lang.StringBuffer mainBodyBuffer
           
 
Constructor Summary
FunctionalSpecificationAspect()
           
 
Method Summary
protected  void addColumnColourValue(java.awt.Color colour)
           
protected  void addColumnHeader(java.lang.String columnHeader)
           
protected  void addColumnValue(java.lang.String columnValue)
           
protected  void addYesNoColumnValue(boolean isYes)
           
protected  void beginColumnValue()
           
protected  void beginParagraph()
           
protected  void beginRow()
           
protected  void beginTable()
           
protected  void endColumnValue()
           
protected  void endParagraph()
           
protected  void endRow()
           
protected  void endTable()
           
abstract  void generateHTML()
          generates the HTML for the functional specification aspect.
protected  java.lang.String getBulletedList(java.lang.String[] items)
           
 java.lang.String getDescription()
          provides the HTML text that was created through the generateHTML() method.
protected  java.lang.String getHyperLinkText(java.lang.String link, java.lang.String body)
           
 java.lang.String getJumpLinkTable()
          provides a part of the jump link table that links to headings that are part of this section of the functional specifications
protected  void printBackToTop()
           
protected  void printBoldHeading(java.lang.String heading)
           
protected  void printBulletedList(java.util.ArrayList items)
           
protected  void printBulletedList(java.lang.String[] items)
           
protected  void printEnumeratedList(java.util.ArrayList items)
           
protected  void printField(java.lang.String fieldName)
           
protected  void printField(java.lang.String fieldName, java.lang.String fieldValue)
           
protected  void printHeading(java.lang.String heading)
           
protected  void printHorizontalLine()
           
protected  void printHyperLink(java.lang.String link, java.lang.String body)
           
protected  void printHyperLink(java.net.URL link, java.lang.String body)
           
protected  void printParagraphSeparator()
           
protected  void printParagraphText(java.lang.String paragraphText)
           
protected  java.lang.String replaceSpacesWithUnderscores(java.lang.String label)
           
 void setSectionNumber(int sectionNumber)
          establishes the section number associated with this section of the functional specification.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

documentHeaderUtility

protected DocumentHeaderUtility documentHeaderUtility

mainBodyBuffer

protected java.lang.StringBuffer mainBodyBuffer

columnValues

protected java.util.ArrayList columnValues
Constructor Detail

FunctionalSpecificationAspect

public FunctionalSpecificationAspect()
Method Detail

getDescription

public java.lang.String getDescription()
provides the HTML text that was created through the generateHTML() method.

Specified by:
getDescription in interface ServiceAspectDescription

getJumpLinkTable

public java.lang.String getJumpLinkTable()
provides a part of the jump link table that links to headings that are part of this section of the functional specifications


generateHTML

public abstract void generateHTML()
generates the HTML for the functional specification aspect.


printBackToTop

protected void printBackToTop()

printField

protected void printField(java.lang.String fieldName)

printField

protected void printField(java.lang.String fieldName,
                          java.lang.String fieldValue)

beginColumnValue

protected void beginColumnValue()

endColumnValue

protected void endColumnValue()

printBoldHeading

protected void printBoldHeading(java.lang.String heading)

printHeading

protected void printHeading(java.lang.String heading)

beginParagraph

protected void beginParagraph()

printParagraphText

protected void printParagraphText(java.lang.String paragraphText)

endParagraph

protected void endParagraph()

replaceSpacesWithUnderscores

protected java.lang.String replaceSpacesWithUnderscores(java.lang.String label)

printHorizontalLine

protected void printHorizontalLine()

printParagraphSeparator

protected void printParagraphSeparator()

printEnumeratedList

protected void printEnumeratedList(java.util.ArrayList items)

printBulletedList

protected void printBulletedList(java.util.ArrayList items)

printBulletedList

protected void printBulletedList(java.lang.String[] items)

getBulletedList

protected java.lang.String getBulletedList(java.lang.String[] items)

printHyperLink

protected void printHyperLink(java.net.URL link,
                              java.lang.String body)

printHyperLink

protected void printHyperLink(java.lang.String link,
                              java.lang.String body)

getHyperLinkText

protected java.lang.String getHyperLinkText(java.lang.String link,
                                            java.lang.String body)

beginRow

protected void beginRow()

endRow

protected void endRow()

beginTable

protected void beginTable()

endTable

protected void endTable()

addColumnHeader

protected void addColumnHeader(java.lang.String columnHeader)

addYesNoColumnValue

protected void addYesNoColumnValue(boolean isYes)

addColumnValue

protected void addColumnValue(java.lang.String columnValue)

addColumnColourValue

protected void addColumnColourValue(java.awt.Color colour)

setSectionNumber

public void setSectionNumber(int sectionNumber)
establishes the section number associated with this section of the functional specification.