org.apache.cocoon.generation
Class FileGenerator

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

All Implemented Interfaces:

org.apache.cocoon.caching.CacheableProcessingComponent, Disposable, org.apache.cocoon.generation.Generator, Poolable, Recyclable, Serviceable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.xml.XMLProducer

Direct Known Subclasses:

CSVGenerator

public class FileGenerator

extends org.apache.cocoon.generation.ServiceableGenerator

implements org.apache.cocoon.caching.CacheableProcessingComponent

The FileGenerator is a class that reads XML from a source and generates SAX Events. The FileGenerator is cacheable.

Version:

$Id: FileGenerator.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

protected Source	inputSource The input source
protected org.apache.cocoon.core.xml.SAXParser	parser The SAX Parser.

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

Constructor Summary

FileGenerator()

Method Summary

void	generate() Generate XML data.
Serializable	getKey() Generate the unique key.
SourceValidity	getValidity() Generate the validity object.
void	recycle() Recycle this component.
void	setParser(org.apache.cocoon.core.xml.SAXParser parser)
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, Parameters par) Setup the file generator.

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

dispose, service

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

Field Detail

inputSource

protected Source inputSource

The input source

parser

protected org.apache.cocoon.core.xml.SAXParser parser

The SAX Parser.

Constructor Detail

FileGenerator

public FileGenerator()

Method Detail

setParser

public void setParser(org.apache.cocoon.core.xml.SAXParser parser)

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

Specified by:

getKey in interface org.apache.cocoon.caching.CacheableProcessingComponent

Returns:

The generated key hashes the src

getValidity

public SourceValidity getValidity()

Generate the validity object.

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