org.apache.cocoon.generation
Class FileGenerator

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.FileGenerator

All Implemented Interfaces:

Cacheable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, 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 FileGenerator

extends ComposerGenerator

implements Cacheable

The FileGenerator is a class that reads XML from a source and generates SAX Events. The FileGenerator implements the Cacheable interface.

Version:

CVS $Id: FileGenerator.java,v 1.7.2.1 2002/04/21 17:33:38 vgritsenko Exp $

Author:

Pierpaolo Fumagalli (Apache Software Foundation, Exoffice Technologies), Carsten Ziegeler

Field Summary

protected Source

inputSource The input source

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

FileGenerator()

Method Summary

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 file generator.

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

compose, dispose

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

Field Detail

inputSource

protected Source inputSource

The input source

Constructor Detail

FileGenerator

public FileGenerator()

Method Detail

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 file 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.

Specified by:

generateKey in interface Cacheable

Returns:

The generated key hashes the src

generateValidity

public CacheValidity generateValidity()

Generate the validity object.

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.