uk.co.weft.domutil
Interface DocumentGenerator

All Known Implementing Classes:

DocumentGeneratorImpl, Form

public interface DocumentGenerator

a DocumentGenerator is an object which generates DOM documents, usually from something in a database.

Version:

$Revision: 1.16.4.3 $ This revision: $Author: simon $

Author:

Simon Brooke

Method Summary

void	destroy() Do any cleaning up I need to do when my Servlet shuts down
Document	generate(Context context) generate a document.
java.lang.String	getTransformURL(Context context) get the URL of my stylesheet as a String.
void	init(Context config) Initialise this generator with configuration information from this context

Method Detail

generate

public Document generate(Context context)
                  throws java.lang.Exception

generate a document. If using the generator_chain mechanism introduced in Jacquard 1.8, a DocumentGenerator can return null from this method to indicate that it doesn't want to handle this context. If it does this the context will be passed to the next generator up the chain. The application designer is responsible for ensuring that the last generator on the chain can handle anything.

Throws:

java.lang.Exception

getTransformURL

public java.lang.String getTransformURL(Context context)
                                 throws GenerationException

get the URL of my stylesheet as a String. If I don't have a preferred stylesheet, return null

Throws:

GenerationException

init

public void init(Context config)
          throws InitialisationException

Initialise this generator with configuration information from this context

Throws:

InitialisationException

destroy

public void destroy()

Do any cleaning up I need to do when my Servlet shuts down