This project has retired. For details please refer to its Attic page.

org.apache.cocoon.generation
Class TextGenerator

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.generation.AbstractGenerator
              org.apache.cocoon.generation.ServiceableGenerator
                  org.apache.cocoon.generation.TextGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Parameterizable, Serviceable, CacheableProcessingComponent, Generator, SitemapModelComponent, XMLProducer

public class TextGenerator
extends ServiceableGenerator
implements Parameterizable, CacheableProcessingComponent

Read a plain text file and produce a valid XML file.

 <text xmlns="http://chaperon.sourceforge.net/schema/text/1.0">
  Text 123 bla
 </text>
 

Version:

CVS $Id: TextGenerator.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Stephan Michels , Rolf Schumacher

Field Summary

static String

URI The URI of the text element

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

TextGenerator()

Method Summary

void	generate() Generate XML data.
Serializable	getKey() Generate the unique key.
SourceValidity	getValidity() Generate the validity object.
void	parameterize(Parameters parameters) Provide component with parameters.
void	recycle() Recycle this component.
void	setup(SourceResolver resolver, Map objectmodel, String src, Parameters parameters) Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.

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.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, 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

URI

public static final String URI

The URI of the text element

See Also:

Constant Field Values

Constructor Detail

TextGenerator

public TextGenerator()

Method Detail

recycle

public void recycle()

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

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractGenerator

parameterize

public void parameterize(Parameters parameters)
                  throws ParameterException

Provide component with parameters.

Specified by:

parameterize in interface Parameterizable

Parameters:

parameters - the parameters

Throws:

ParameterException - if parameters are invalid

setup

public void setup(SourceResolver resolver,
                  Map objectmodel,
                  String src,
                  Parameters parameters)
           throws ProcessingException,
                  SAXException,
                  IOException

Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Parameters:

resolver - Source resolver

objectmodel - Object model

src - Source

parameters - Parameters

Throws:

IOException

ProcessingException

SAXException

getKey

public Serializable getKey()

Generate the unique key. This key must be unique inside the space of this component.

Specified by:

getKey in interface CacheableProcessingComponent

Returns:

The generated key hashes the src

getValidity

public SourceValidity getValidity()

Generate the validity object.

Specified by:

getValidity in interface CacheableProcessingComponent

Returns:

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

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Generate XML data.

Specified by:

generate in interface Generator

Throws:

IOException

ProcessingException

SAXException