dochelper.Renderer Interface Reference

Inheritance diagram for dochelper.Renderer:

[legend]

Collaboration diagram for dochelper.Renderer:

[legend]

List of all members.

Public Member Functions
void	execute (ResultNode doc) throws ResourceUnavailableException
	Main method of the renderer.
void	addDocumentSection (DocumentSection docsection, String key)
	Add a Document Section to the Map of Document Section to use while rendering.

---

Detailed Description

Author:

gchristen

Definition at line 18 of file Renderer.java.

---

Member Function Documentation

void dochelper.Renderer.execute

(

ResultNode

doc

)

throws ResourceUnavailableException

Main method of the renderer.

This method should convert the input ResultNode</code node into output. The node passed in as input represents the root of the tree to convert.

It is the renderer's responsibility to fetch the correct output info for each record set. Specifically docsections may be define for each onde in the tree for this renderer, these should be fetched and applied.

Parameters:

doc

The node that represent the root of the tree to process.

Exceptions:

	ResourceUnavailableException
	Exception

Implemented in dochelper.FileRenderer.

void dochelper.Renderer.addDocumentSection	(	DocumentSection	docsection,
		String	key
	)

Add a Document Section to the Map of Document Section to use while rendering.

Parameters:

	docsection	DocumentSection to add to Map.
	key	String representing the object we wish to apply this Document Section to.

Implemented in dochelper.FileRenderer.

Here is the caller graph for this function:

---

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

• src/dochelper/Renderer.java