org.apache.cocoon.generation
Class HTMLGenerator

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

All Implemented Interfaces:

Cacheable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, Generator, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, SitemapModelComponent, XMLProducer

public class HTMLGenerator

extends ComposerGenerator

implements org.apache.avalon.framework.configuration.Configurable, Cacheable, org.apache.avalon.framework.activity.Disposable

Version:

CVS $Id: HTMLGenerator.java,v 1.14.2.2 2002/12/01 22:09:12 sylvain Exp $

Author:

Davanum Srinivas, Carsten Ziegeler, Nicola Ken Barozzi, Sylvain Wallez

Fields inherited from class org.apache.cocoon.generation.ComposerGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

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

contentHandler, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

HTMLGenerator()

Method Summary

void	compose(org.apache.avalon.framework.component.ComponentManager manager) Set the current ComponentManager instance used by this Composable.
void	configure(org.apache.avalon.framework.configuration.Configuration config)
void	dispose() Release all resources.
void	generate() Generate XML data.
long	generateKey() Generate the unique key.
CacheValidity	generateValidity() Generate the validity object.
void	recycle() Recycle this component.
void	setup(SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters par) Setup the html generator.

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.xml.XMLProducer

setConsumer

Constructor Detail

HTMLGenerator

public HTMLGenerator()

Method Detail

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException

Description copied from class: ComposerGenerator

Set the current ComponentManager instance used by this Composable.

Overrides:

compose in class ComposerGenerator

configure

public void configure(org.apache.avalon.framework.configuration.Configuration config)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

recycle

public void recycle()

Recycle this component. All instance variables are set to null.

Overrides:

recycle in class AbstractGenerator

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

Setup the html generator. Try to get the last modification date of the source for caching.

Overrides:

setup in class AbstractGenerator

generateKey

public long generateKey()

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:

generateKey in interface Cacheable

Returns:

The generated key or 0 if the component is currently not cacheable.

generateValidity

public CacheValidity generateValidity()

Generate the validity object. Before this method can be invoked the generateKey() method must be invoked.

Specified by:

generateValidity in interface Cacheable

Returns:

The generated validity object or null if the component is currently not cacheable.

generate

public void generate()
              throws java.io.IOException,
                     org.xml.sax.SAXException,
                     ProcessingException

Generate XML data.

dispose

public void dispose()

Description copied from class: ComposerGenerator

Release all resources.

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

Overrides:

dispose in class ComposerGenerator