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

org.apache.cocoon.template
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.template.JXTemplateGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

EventAwareGenerator

public class JXTemplateGenerator
extends ServiceableGenerator
implements CacheableProcessingComponent

Version:

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

Field Summary

static String	CACHE_KEY
static String	NS The namespace used by this generator
static String	VALIDITY

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()

Method Summary

void	dispose() Release all resources.
void	generate() Generate the XML and stream it into the pipeline
XMLConsumer	getConsumer()
Serializable	getKey() Generate the unique key.
SourceValidity	getValidity() Generate the validity object.
void	performGeneration(Event startEvent, Event endEvent)
void	recycle() Recycle the generator by removing references
void	service(ServiceManager manager) Set the current ServiceManager instance used by this Serviceable.
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters parameters) Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

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

The namespace used by this generator

See Also:

Constant Field Values

CACHE_KEY

public static final String CACHE_KEY

See Also:

Constant Field Values

VALIDITY

public static final String VALIDITY

See Also:

Constant Field Values

Constructor Detail

JXTemplateGenerator

public JXTemplateGenerator()

Method Detail

getConsumer

public XMLConsumer getConsumer()

service

public void service(ServiceManager manager)
             throws ServiceException

Description copied from class: ServiceableGenerator

Set the current ServiceManager instance used by this Serviceable.

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

See Also:

ServiceableGenerator.service(org.apache.avalon.framework.service.ServiceManager)

dispose

public void dispose()

Description copied from class: ServiceableGenerator

Release all resources.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class ServiceableGenerator

See Also:

ServiceableGenerator.dispose()

recycle

public void recycle()

Description copied from class: AbstractGenerator

Recycle the generator by removing references

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractGenerator

See Also:

AbstractGenerator.recycle()

setup

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

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

See Also:

AbstractGenerator.setup(org.apache.cocoon.environment.SourceResolver, java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters)

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Description copied from interface: Generator

Generate the XML and stream it into the pipeline

Specified by:

generate in interface Generator

Throws:

IOException

SAXException

ProcessingException

See Also:

Generator.generate()

performGeneration

public void performGeneration(Event startEvent,
                              Event endEvent)
                       throws SAXException

Throws:

SAXException

getKey

public Serializable getKey()

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.

See Also:

CacheableProcessingComponent.getKey()

getValidity

public SourceValidity getValidity()

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.

See Also:

CacheableProcessingComponent.getValidity()