dochelper.DocumentDefinition Class Reference

The class DocumentDefinition implements one of the launch points for the DocHelper process. More...

Collaboration diagram for dochelper.DocumentDefinition:

List of all members.

Public Member Functions

DocumentDefinition ()

Constructors for Document Definition.

DocumentDefinition (String name)

Constructor to create instance.

ArrayList< RecordSet > getRecordSets ()

Return the list of RecordSets for this Document Definition.

void setRecordSets (ArrayList< RecordSet > recordSets)

Set the list of RecordSet s to use for this DocumentDefinition.

void addRecordSet (RecordSet rs)

Add a RecordSet to the list of RecordSets to be used to create the output Document.

void addProcessor (String key, Processor ps)

Add a Processor for this document.

void addRenderer (Renderer r)

Add a Renderer to the list of Renderer that will create output for this document.

void execute ()

Execute DocumentDefinition.

void render ()

Fetches all the Renderers associated with the document and executes them passing this document's result node tree a the tree to render.

void executeProcessors ()

ResultNode getDocument ()

void setDocument (ResultNode result)

Set the root result node.

Hashtable< String, Processor > getProcessors ()

ArrayList< Renderer > getRenderers ()

Protected Attributes

ArrayList< RecordSet > recordSets

Package Attributes

String name

Name that identifies this Document Definition.

Private Attributes

Hashtable< String, Processor > processors

ArrayList< Renderer > renderers

ResultNode _result = null

Detailed Description

The class DocumentDefinition implements one of the launch points for the DocHelper process.

It holds the main elements that compose a Document : RecordSets.

This class conatains a DocumentSection in order to implement output encapsulation. Since DocumentDefinition is the top most element, begining and end sections are defined within (if any) the DocumentSection object.

See also:: DocumentSection

Author:: Guillermo Christen

Definition at line 31 of file DocumentDefinition.java.

Constructor & Destructor Documentation

dochelper.DocumentDefinition.DocumentDefinition ( )

Constructors for Document Definition.

Definition at line 63 of file DocumentDefinition.java.

dochelper.DocumentDefinition.DocumentDefinition ( String name )

Constructor to create instance.

Parameters:

name

Definition at line 74 of file DocumentDefinition.java.

Member Function Documentation

ArrayList<RecordSet> dochelper.DocumentDefinition.getRecordSets ( )

Return the list of RecordSets for this Document Definition.

Returns:: ArrayList<RecordSet> list of RecordSets.

Definition at line 84 of file DocumentDefinition.java.

void dochelper.DocumentDefinition.setRecordSets ( ArrayList< RecordSet > recordSets )

Set the list of RecordSet s to use for this DocumentDefinition.

Parameters:

recordSets

Definition at line 94 of file DocumentDefinition.java.

void dochelper.DocumentDefinition.addRecordSet ( RecordSet rs )

Add a RecordSet to the list of RecordSets to be used to create the output Document.

Parameters:

rs

RecordSet to add.

Definition at line 104 of file DocumentDefinition.java.

Here is the caller graph for this function:

void dochelper.DocumentDefinition.addProcessor	(	String	key,
		Processor	ps
	)

Add a Processor for this document.

Parameters:

ps

Processor to add.

Definition at line 114 of file DocumentDefinition.java.

Here is the call graph for this function:

Here is the caller graph for this function:

void dochelper.DocumentDefinition.addRenderer ( Renderer r )

Add a Renderer to the list of Renderer that will create output for this document.

Parameters:

r

Renderer to add.

Definition at line 125 of file DocumentDefinition.java.

Here is the call graph for this function:

Here is the caller graph for this function:

void dochelper.DocumentDefinition.execute ( )

Execute DocumentDefinition.

This method is the main driver of DocHelper. It is expected that RecordSets defined for the DocumentDefinition are in the correct state. This method will invoke the execute method of all record sets defined for it. It DOES NOT check or guarantee that record sets wihtin it are ready for execution.

The result from executing each RecordSet is the creation of a ResultNode tree that contains all nessesary info to render a document definition according to the render used.

Exceptions:

Exception

Definition at line 142 of file DocumentDefinition.java.

Here is the call graph for this function:

void dochelper.DocumentDefinition.render ( )

Fetches all the Renderers associated with the document and executes them passing this document's result node tree a the tree to render.

Exceptions:

Exception

Definition at line 163 of file DocumentDefinition.java.

Here is the call graph for this function:

void dochelper.DocumentDefinition.executeProcessors ( )

Definition at line 175 of file DocumentDefinition.java.

Here is the call graph for this function:

ResultNode dochelper.DocumentDefinition.getDocument ( )

Returns:

Definition at line 204 of file DocumentDefinition.java.

Here is the caller graph for this function:

void dochelper.DocumentDefinition.setDocument ( ResultNode result )

Set the root result node.

This represents the result of executing this DocumentDefinition.

Parameters:

result

ResultNode which is the root of the result node tree.

Definition at line 215 of file DocumentDefinition.java.

Here is the caller graph for this function:

Hashtable<String, Processor> dochelper.DocumentDefinition.getProcessors ( )

Returns:: the processors

Definition at line 222 of file DocumentDefinition.java.

Here is the caller graph for this function:

ArrayList<Renderer> dochelper.DocumentDefinition.getRenderers ( )

Returns:: the renderers

Definition at line 229 of file DocumentDefinition.java.

Here is the caller graph for this function:

Member Data Documentation

ArrayList<RecordSet> dochelper.DocumentDefinition.recordSets [protected]

Definition at line 37 of file DocumentDefinition.java.

Hashtable<String, Processor> dochelper.DocumentDefinition.processors [private]

Definition at line 42 of file DocumentDefinition.java.

ArrayList<Renderer> dochelper.DocumentDefinition.renderers [private]

Definition at line 47 of file DocumentDefinition.java.

ResultNode dochelper.DocumentDefinition._result = null [private]

Definition at line 52 of file DocumentDefinition.java.

String dochelper.DocumentDefinition.name [package]

Name that identifies this Document Definition.

Definition at line 57 of file DocumentDefinition.java.

The documentation for this class was generated from the following file:

src/dochelper/DocumentDefinition.java


Public Member Functions
	DocumentDefinition ()
	Constructors for Document Definition.
	DocumentDefinition (String name)
	Constructor to create instance.
ArrayList< RecordSet >	getRecordSets ()
	Return the list of RecordSets for this Document Definition.
void	setRecordSets (ArrayList< RecordSet > recordSets)
	Set the list of RecordSet s to use for this DocumentDefinition.
void	addRecordSet (RecordSet rs)
	Add a RecordSet to the list of RecordSets to be used to create the output Document.
void	addProcessor (String key, Processor ps)
	Add a Processor for this document.
void	addRenderer (Renderer r)
	Add a Renderer to the list of Renderer that will create output for this document.
void	execute ()
	Execute DocumentDefinition.
void	render ()
	Fetches all the Renderers associated with the document and executes them passing this document's result node tree a the tree to render.
void	executeProcessors ()
ResultNode	getDocument ()
void	setDocument (ResultNode result)
	Set the root result node.
Hashtable< String, Processor >	getProcessors ()
ArrayList< Renderer >	getRenderers ()
Protected Attributes
ArrayList< RecordSet >	recordSets
Package Attributes
String	name
	Name that identifies this Document Definition.
Private Attributes
Hashtable< String, Processor >	processors
ArrayList< Renderer >	renderers
ResultNode	_result = null