org.apache.cocoon.generation
Class AbstractGenerator

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AsciiArtSVGGenerator, ComposerGenerator, ExceptionGenerator, FormsGenerator, HSSFGenerator, IMAPGenerator, NotifyingGenerator, ParseExceptionGenerator, ServiceableGenerator, SessionAttributeGenerator, WoodyGenerator, XMidiGenerator

public abstract class AbstractGenerator
extends AbstractXMLProducer
implements Generator

An abstract class that can be used to implement an own generator. If you need other components, use the ServiceableGenerator instead.

Version:

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

Author:

Pierpaolo Fumagalli (Apache Software Foundation)

Field Summary

protected Map	objectModel The current Map objectModel.
protected Parameters	parameters The current Parameters.
protected SourceResolver	resolver The current SourceResolver.
protected String	source The source URI associated with the request or null.

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

AbstractGenerator()

Method Summary

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.generation.Generator

generate

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

setConsumer

Field Detail

resolver

protected SourceResolver resolver

The current SourceResolver.

objectModel

protected Map objectModel

The current Map objectModel.

parameters

protected Parameters parameters

The current Parameters.

source

protected String source

The source URI associated with the request or null.

Constructor Detail

AbstractGenerator

public AbstractGenerator()

Method Detail

setup

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

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

Specified by:

setup in interface SitemapModelComponent

Throws:

ProcessingException

SAXException

IOException

recycle

public void recycle()

Recycle the generator by removing references

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractXMLProducer