org.apache.cocoon.forms.generation
Class FormsGenerator

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.generation.AbstractGenerator
              org.apache.cocoon.forms.generation.FormsGenerator

All Implemented Interfaces:

Poolable, Recyclable, Component, LogEnabled, Generator, SitemapModelComponent, XMLProducer

public class FormsGenerator
extends AbstractGenerator

A generator that streams an XML representation of a Form. This will recursively contain the XML for all widgets on the form. This can then be styled using an XSLT.

An alternative approach that requires less (or even none) XSLT work is offered by the FormsTemplateTransformer.

The Form whose XML should be produced should reside either

1. In a request attribute, whose name should be provided to this generator as a sitemap parameter called "attribute-name".
2. Or else at its default-location in the flow context-object.

Version:

$Id: FormsGenerator.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

protected FormsPipelineConfig

config

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

FormsGenerator()

Method Summary

void	generate() Generate the XML and stream it into the pipeline
void	recycle() Recycle the generator by removing references
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters par) Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

config

protected FormsPipelineConfig config

Constructor Detail

FormsGenerator

public FormsGenerator()

Method Detail

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Description copied from class: AbstractGenerator

Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Throws:

ProcessingException

SAXException

IOException

recycle

public void recycle()

Description copied from class: AbstractGenerator

Recycle the generator by removing references

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractGenerator

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Description copied from interface: Generator

Generate the XML and stream it into the pipeline

Throws:

IOException

SAXException

ProcessingException