org.apache.cocoon.generation
Class FileGeneratorBean

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.generation.FileGeneratorBean
All Implemented Interfaces:
org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.cocoon.sitemap.DisposableSitemapComponent, org.apache.cocoon.generation.Generator, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.xml.XMLProducer
Direct Known Subclasses:
CSVGeneratorBean

public class FileGeneratorBean
extends org.apache.cocoon.util.AbstractLogEnabled
implements org.apache.cocoon.generation.Generator, org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.cocoon.sitemap.DisposableSitemapComponent

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

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

Field Summary
protected  org.apache.cocoon.xml.XMLConsumer consumer
          The consumer.
protected  Source inputSource
          The input source
protected  org.apache.cocoon.core.xml.SAXParser parser
          The SAX Parser.
protected  org.apache.cocoon.environment.SourceResolver resolver
          The source resolver.
 
Fields inherited from interface org.apache.cocoon.generation.Generator
ROLE
 
Constructor Summary
FileGeneratorBean()
           
 
Method Summary
 void dispose()
           
 void generate()
          Generate XML data.
 Serializable getKey()
          Generate the unique key.
 SourceValidity getValidity()
          Generate the validity object.
 void setConsumer(org.apache.cocoon.xml.XMLConsumer consumer)
           
 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.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

inputSource

protected Source inputSource
The input source


resolver

protected org.apache.cocoon.environment.SourceResolver resolver
The source resolver.


consumer

protected org.apache.cocoon.xml.XMLConsumer consumer
The consumer.


parser

protected org.apache.cocoon.core.xml.SAXParser parser
The SAX Parser.

Constructor Detail

FileGeneratorBean

public FileGeneratorBean()
Method Detail

setParser

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

dispose

public void dispose()
Specified by:
dispose in interface org.apache.cocoon.sitemap.DisposableSitemapComponent
See Also:
DisposableSitemapComponent.dispose()

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
See Also:
SitemapModelComponent.setup(SourceResolver, Map, String, Parameters)

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.

setConsumer

public void setConsumer(org.apache.cocoon.xml.XMLConsumer consumer)
Specified by:
setConsumer in interface org.apache.cocoon.xml.XMLProducer
See Also:
XMLProducer.setConsumer(XMLConsumer)

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


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.