org.apache.cocoon.generation
Class AbstractGenerator

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.generation.AbstractGenerator

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, Generator, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

ComposerGenerator, FragmentExtractorGenerator, SessionAttributeGenerator

public abstract class AbstractGenerator

extends AbstractXMLProducer

implements Generator

Version:

CVS $Id: AbstractGenerator.java,v 1.4 2002/02/22 07:03:51 cziegeler Exp $

Author:

Pierpaolo Fumagalli (Apache Software Foundation, Exoffice Technologies)

Field Summary

protected java.util.Map	objectModel The current Map objectModel.
protected org.apache.avalon.framework.parameters.Parameters	parameters The current Parameters.
protected SourceResolver	resolver The current SourceResolver.
protected java.lang.String	source The source URI associated with the request or null.

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

contentHandler, 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, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.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.AbstractLoggable

getLogger, setLogger, 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 java.util.Map objectModel

The current Map objectModel.

parameters

protected org.apache.avalon.framework.parameters.Parameters parameters

The current Parameters.

source

protected java.lang.String source

The source URI associated with the request or null.

Constructor Detail

AbstractGenerator

public AbstractGenerator()

Method Detail

setup

public void setup(SourceResolver resolver,
                  java.util.Map objectModel,
                  java.lang.String src,
                  org.apache.avalon.framework.parameters.Parameters par)
           throws ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException

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

Specified by:

setup in interface SitemapModelComponent

recycle

public void recycle()

Recycle the generator by removing references

Overrides:

recycle in class AbstractXMLProducer