org.apache.cocoon.generation
Class HTMLGenerator
java.lang.Object
org.apache.cocoon.util.AbstractLogEnabled
org.apache.cocoon.xml.AbstractXMLProducer
org.apache.cocoon.generation.AbstractGenerator
org.apache.cocoon.generation.ServiceableGenerator
org.apache.cocoon.generation.HTMLGenerator
- All Implemented Interfaces:
- org.apache.cocoon.caching.CacheableProcessingComponent, Configurable, Disposable, org.apache.cocoon.generation.Generator, Poolable, Recyclable, Serviceable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.xml.XMLProducer
- public class HTMLGenerator
- extends org.apache.cocoon.generation.ServiceableGenerator
- implements Configurable, org.apache.cocoon.caching.CacheableProcessingComponent, Disposable
The HTML generator reads HTML from a source, converts it to XHTML
using JTidy and generates SAX Events.
- Version:
- $Id: HTMLGenerator.html 1304280 2012-03-23 11:18:01Z ilgrosso $
Field Summary |
static String |
FORM_NAME
The parameter that specifies what request attribute to use, if any |
Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator |
manager |
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 |
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
setConsumer, setContentHandler, setLexicalHandler |
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled |
getLogger, setLogger |
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 |
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
- Specified by:
service
in interface Serviceable
- 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
setup
public void setup(org.apache.cocoon.environment.SourceResolver resolver,
Map objectModel,
String src,
Parameters par)
throws org.apache.cocoon.ProcessingException,
SAXException,
IOException
- Setup the html generator.
Try to get the last modification date of the source for caching.
- Specified by:
setup
in interface org.apache.cocoon.sitemap.SitemapModelComponent
- Throws:
org.apache.cocoon.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 org.apache.cocoon.caching.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 org.apache.cocoon.caching.CacheableProcessingComponent
- Returns:
- The generated validity object or
null
if the
component is currently not cacheable.
generate
public void generate()
throws IOException,
SAXException,
org.apache.cocoon.ProcessingException
- Generate XML data.
- Specified by:
generate
in interface org.apache.cocoon.generation.Generator
- Throws:
IOException
SAXException
org.apache.cocoon.ProcessingException
dispose
public void dispose()
- Specified by:
dispose
in interface Disposable
Copyright © 1999-2008 The Apache Software Foundation. All Rights Reserved.