Package xbn.template

Separate functional and visual responsibilities through the use of "templates".

See:
Description

TOP Interface Summary

TFilter

Classes implementing TFilter indicate they can determine the validity of a Template.

TOP Class Summary

GapConfig	Configuration for a Template.
OGCOne	The configuration for a TOGOne.
OGConfig	The configuration for a TemplateOrderedGaps.
OGCThree	The configuration for a TOGThree.
OGCTwo	The configuration for a TOGTwo.
TConfigDefaults	Default configurations used throughout the template package.
TDOSArray	Manage multiple TemplateDataOrStrings.
Template	A template is text that contains one or more ~G~gaps~EG~, each representing a piece of information whose value is populated at runtime.
TemplateArray	Manage multiple Templates.
TemplateData	Holds the data for a single Template.
TemplateDataOrString	Analyzes source text that may or may not have gaps in it.
TemplateFiller	Take a Template, fill each gap with something, and output the resulting text.
TemplateLineAnalyzer	For every line found in a template, this class retrieves surrounding text and gaps.
TemplateOrderedGaps	A Template that has a specific set of unique gaps.
TLAObjects	A trivial class used only to hold internal objects for TemplateLineAnalyzer.
TOGOne	A TemplateOrderedGaps where there is always one gap.
TOGThree	A TemplateOrderedGaps where there are always three gaps.
TOGTwo	A TemplateOrderedGaps where there are always two gaps.
TParseConfig	Configuration for when parsing the source text for a single Template.
UtilGap	Random functions to create, manipulate and analyze template gaps.

TOP Exception Summary

TemplateFormatException

An exception indicating a formatting error was found in the source text for a Template.

TOP Package xbn.template Description

Separate functional and visual responsibilities through the use of "templates". The goal: Don't have any visual presentation in the code, and don't have any logic in the templates.

Getting started with this package

Take a look at the example code for TemplateFiller.

The classes outside of the template package that are the most important, supplementally, to Templates:

• xbn.output.OWriter, and all its sub classes: Feeding an OWriter into TemplateFiller, via setOWriter makes resulting output be pumped to an alternative location, on the fly, as gaps are filled.
• xbn.util.FLRFile and xbn.util.FLRString: Where the source text for a Template comes from. Extend xbn.util.ForLineRetrieval if your source text comes from a different place.
• xbn.output.Outputter: Both Template and TemplateFiller allow you to see what they do inside their black boxes. Feed an Outputter into Template's constructor, or TemplateFiller.setOutputter). If you have any confusion related to the template files that you've created, this may help make things clearer for you.

Jeff Labonski

Jeff Labonski was an intern at the Wharton school, who created the original incarnation of this package, under my direction and design. TemplateParser lives on, man!