project35.specifications
Class DocumentHeaderUtility

java.lang.Object
  project35.specifications.DocumentHeaderUtility

public class DocumentHeaderUtility
extends java.lang.Object

This is utility developed to keep track of headings in generated functional specifications. The class is invoked in the following manner: StringBuffer mainBodyBuffer = new StringBuffer(); ... DocumentHeaderUtility documentHeaderUtility = new DocumentHeaderUtility(sectionNumber); documentHeader.start(); ... String header = documentHeaderUtility.createHeading(DocumentHeaderUtility.SUB_SUB_SUB_HEADER, "record_class_name_organism", "Organism"); mainBodyBuffer.append(header); ... documentHeader.stop(); String jumpTable = documentHeaderUtility.getJumpTable();

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)

Field Summary

static java.lang.Integer	HEADER
static java.lang.Integer	SUB_HEADER
static java.lang.Integer	SUB_SUB_HEADER
static java.lang.Integer	SUB_SUB_SUB_HEADER

Constructor Summary

DocumentHeaderUtility(int sectionNumber)

Method Summary

java.lang.String	createHeading(java.lang.Integer headerLevel, java.lang.String jumpLinkCode, java.lang.String value) this method creates a new section heading and adds it to a table of jump links
java.lang.String	getJumpTable()
void	start() Initialises the utility, especially starting off the jump link table
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

public static final java.lang.Integer HEADER

SUB_HEADER

public static final java.lang.Integer SUB_HEADER

SUB_SUB_HEADER

public static final java.lang.Integer SUB_SUB_HEADER

SUB_SUB_SUB_HEADER

public static final java.lang.Integer SUB_SUB_SUB_HEADER

Constructor Detail

DocumentHeaderUtility

public DocumentHeaderUtility(int sectionNumber)

Method Detail

start

public void start()

Initialises the utility, especially starting off the jump link table

stop

public void stop()

getJumpTable

public java.lang.String getJumpTable()

createHeading

public java.lang.String createHeading(java.lang.Integer headerLevel,
                                      java.lang.String jumpLinkCode,
                                      java.lang.String value)

this method creates a new section heading and adds it to a table of jump links