org.apache.cocoon.generation
Class HTMLGenerator
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.xml.AbstractXMLProducer
org.apache.cocoon.generation.AbstractGenerator
org.apache.cocoon.generation.ServiceableGenerator
org.apache.cocoon.generation.HTMLGenerator
- All Implemented Interfaces:
- CacheableProcessingComponent, Configurable, Disposable, Generator, LogEnabled, Poolable, Recyclable, Serviceable, SitemapModelComponent, XMLProducer
- public class HTMLGenerator
- extends ServiceableGenerator
- implements Configurable, CacheableProcessingComponent, Disposable
- Version:
- CVS $Id: HTMLGenerator.java 153227 2005-02-10 15:00:57Z cziegeler $
- Author:
- Davanum Srinivas, Carsten Ziegeler, Nicola Ken Barozzi, Gianugo Rabellino
- Cocoon.sitemap.component.documentation:
- The html generator reads HTML from a source, converts it to XHTML
and generates SAX Events.
- Cocoon.sitemap.component.documentation.caching:
- Uses the last modification date of the xml document for validation
- Cocoon.sitemap.component.label:
- content
- Cocoon.sitemap.component.logger:
- sitemap.generator.html
- Cocoon.sitemap.component.name:
- html
- Cocoon.sitemap.component.pooling.max:
- 32
Field Summary |
static String |
FORM_NAME
The parameter that specifies what request attribute to use, if any |
Fields inherited from interface org.apache.cocoon.generation.Generator |
ROLE |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FORM_NAME
public static final String FORM_NAME
- The parameter that specifies what request attribute to use, if any
- See Also:
- Constant Field Values
HTMLGenerator
public HTMLGenerator()
service
public void service(ServiceManager manager)
throws ServiceException
- Description copied from class:
ServiceableGenerator
- Set the current
ServiceManager
instance used by this
Serviceable
.
- Specified by:
service
in interface Serviceable
- Overrides:
service
in class ServiceableGenerator
- Throws:
ServiceException
configure
public void configure(Configuration config)
throws ConfigurationException
- Specified by:
configure
in interface Configurable
- Throws:
ConfigurationException
recycle
public void recycle()
- Recycle this component.
All instance variables are set to
null
.
- Specified by:
recycle
in interface Recyclable
- Overrides:
recycle
in class AbstractGenerator
setup
public void setup(SourceResolver resolver,
Map objectModel,
String src,
Parameters par)
throws ProcessingException,
SAXException,
IOException
- Setup the html generator.
Try to get the last modification date of the source for caching.
- Specified by:
setup
in interface SitemapModelComponent
- Overrides:
setup
in class AbstractGenerator
- Throws:
ProcessingException
SAXException
IOException
getKey
public Serializable getKey()
- Generate the unique key.
This key must be unique inside the space of this component.
This method must be invoked before the generateValidity() method.
- Specified by:
getKey
in interface CacheableProcessingComponent
- Returns:
- The generated key or
0
if the component
is currently not cacheable.
getValidity
public SourceValidity getValidity()
- Generate the validity object.
Before this method can be invoked the generateKey() method
must be invoked.
- Specified by:
getValidity
in interface CacheableProcessingComponent
- Returns:
- The generated validity object or
null
if the
component is currently not cacheable.
generate
public void generate()
throws IOException,
SAXException,
ProcessingException
- Generate XML data.
- Specified by:
generate
in interface Generator
- Throws:
IOException
SAXException
ProcessingException
dispose
public void dispose()
- Description copied from class:
ServiceableGenerator
- Release all resources.
- Specified by:
dispose
in interface Disposable
- Overrides:
dispose
in class ServiceableGenerator
Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.