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

org.apache.cocoon.generation
Class JXTemplateGenerator

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

All Implemented Interfaces:

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

Deprecated. Replaced with the template block: JXTemplateGenerator.

public class JXTemplateGenerator
extends ServiceableGenerator
implements CacheableProcessingComponent

Version:

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

Nested Class Summary

static class	JXTemplateGenerator.ErrorHolder Deprecated.
static class	JXTemplateGenerator.LocationFacade Deprecated. Facade to the Location to be set on the consumer prior to sending other events, location member changeable
static class	JXTemplateGenerator.LoopTagStatus Deprecated.
static class	JXTemplateGenerator.TransformerAdapter Deprecated. Adapter that makes this generator usable as a transformer (Note there is a performance penalty for this however: you effectively recompile the template for every instance document)

Field Summary

static String

NS Deprecated. The namespace used by this generator

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

JXTemplateGenerator()
Deprecated.

Method Summary

void	generate() Deprecated. Generate the XML and stream it into the pipeline
Serializable	getKey() Deprecated. Generate the unique key.
SourceValidity	getValidity() Deprecated. Generate the validity object.
void	recycle() Deprecated. Recycle the generator by removing references
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters parameters) Deprecated. Set the SourceResolver, object model 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

NS

public static final String NS

Deprecated.

The namespace used by this generator

See Also:

Constant Field Values

Constructor Detail

JXTemplateGenerator

public JXTemplateGenerator()

Deprecated.

Method Detail

recycle

public void recycle()

Deprecated.

Description copied from class: AbstractGenerator

Recycle the generator by removing references

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractGenerator

setup

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

Deprecated.

Description copied from class: AbstractGenerator

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

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Throws:

ProcessingException

SAXException

IOException

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Deprecated.

Description copied from interface: Generator

Generate the XML and stream it into the pipeline

Specified by:

generate in interface Generator

Throws:

IOException

SAXException

ProcessingException

getKey

public Serializable getKey()

Deprecated.

Description copied from interface: CacheableProcessingComponent

Generate the unique key. This key must be unique inside the space of this component. This method must be invoked before the getValidity() method.

Specified by:

getKey in interface CacheableProcessingComponent

Returns:

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

getValidity

public SourceValidity getValidity()

Deprecated.

Description copied from interface: CacheableProcessingComponent

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

Specified by:

getValidity in interface CacheableProcessingComponent

Returns:

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