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:
- Generator, LogEnabled, Poolable, Recyclable, SitemapModelComponent, XMLProducer
- Direct Known Subclasses:
- AsciiArtSVGGenerator, ExceptionGenerator, FormsGenerator, HSSFGenerator, IMAPGenerator, JellyGenerator, NotifyingGenerator, ParseExceptionGenerator, RequestParameterGenerator, ServiceableGenerator, ServletGenerator, SessionAttributeGenerator, 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.java 30941 2004-07-29 19:56:58Z vgritsenko $
- Author:
- Pierpaolo Fumagalli
(Apache Software Foundation)
Fields inherited from interface org.apache.cocoon.generation.Generator |
ROLE |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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.
AbstractGenerator
public AbstractGenerator()
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
- Parameters:
resolver
- The SourceResolver
to find resources within your context.objectModel
- A java.util.Map
that contains the request and session information.src
- The value of the "src" attribute in the sitemap.par
- The sitemap parameters passed into your component.
- Throws:
ProcessingException
- if there is any other unexpected problem.
IOException
- if there is a problem reading files.
SAXException
- if there is a problem reading a SAX stream.
recycle
public void recycle()
- Recycle the generator by removing references
- Specified by:
recycle
in interface Recyclable
- Overrides:
recycle
in class AbstractXMLProducer
Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.