org.apache.cocoon.components.profiler
Class ProfilingCachingEventPipeline

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.components.pipeline.AbstractEventPipeline
                    |
                    +--org.apache.cocoon.components.pipeline.CachingEventPipeline
                          |
                          +--org.apache.cocoon.components.profiler.ProfilingCachingEventPipeline

All Implemented Interfaces:

CacheableEventPipeline, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.activity.Disposable, EventPipeline, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.framework.component.Recomposable, org.apache.avalon.excalibur.pool.Recyclable, XMLProducer

public class ProfilingCachingEventPipeline

extends CachingEventPipeline

implements org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.activity.Disposable

Version:

CVS $Id: ProfilingCachingEventPipeline.java,v 1.4 2002/02/22 07:00:11 cziegeler Exp $

Author:

Vadim Gritsenko

Fields inherited from class org.apache.cocoon.components.pipeline.AbstractEventPipeline

configuredSAXConnector, connectors, generator, generatorParam, generatorSelector, generatorSource, manager, newManager, transformerParams, transformers, transformerSelectors, transformerSources

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.components.pipeline.EventPipeline

ROLE

Constructor Summary

ProfilingCachingEventPipeline()

Method Summary

void	addTransformer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param) Add a transformer.
void	compose(org.apache.avalon.framework.component.ComponentManager manager)
void	dispose()
boolean	process(Environment environment) Process the given Environment, producing the output.
void	recycle() Recycle the producer by removing references
void	setGenerator(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param) Set the generator.
void	setGenerator(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param, java.lang.Exception e) Same as setGenerator(String, String, Parameters) with an additional Exception parameter.

Methods inherited from class org.apache.cocoon.components.pipeline.CachingEventPipeline

generateKey, generateValidity, setStreamPipelineCaches

Methods inherited from class org.apache.cocoon.components.pipeline.AbstractEventPipeline

checkPipeline, connectPipeline, getGenerator, recompose, setupPipeline

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable

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

Constructor Detail

ProfilingCachingEventPipeline

public ProfilingCachingEventPipeline()

Method Detail

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException

Specified by:

compose in interface org.apache.avalon.framework.component.Composable

Overrides:

compose in class CachingEventPipeline

dispose

public void dispose()

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

Overrides:

dispose in class CachingEventPipeline

setGenerator

public void setGenerator(java.lang.String role,
                         java.lang.String source,
                         org.apache.avalon.framework.parameters.Parameters param,
                         java.lang.Exception e)
                  throws java.lang.Exception

Description copied from interface: EventPipeline

Same as EventPipeline.setGenerator(String, String, Parameters) with an additional Exception parameter. This is used for setting the special {link org.apache.cocoon.sitemap.ErrorNotifier} generator used to generate input for error pages.

Overrides:

setGenerator in class AbstractEventPipeline

Following copied from interface: org.apache.cocoon.components.pipeline.EventPipeline

Parameters:

role - the generator role in the component manager.

source - the source where to produce XML from (e.g. xml file), or null if no source is given.

param - the parameters for the generator.

e - the exception to generate.

Throws:

java.lang.Exception - if the generator couldn't be obtained.

See Also:

ErrorNotifier

setGenerator

public void setGenerator(java.lang.String role,
                         java.lang.String source,
                         org.apache.avalon.framework.parameters.Parameters param)
                  throws java.lang.Exception

Description copied from class: CachingEventPipeline

Set the generator.

Overrides:

setGenerator in class CachingEventPipeline

Following copied from interface: org.apache.cocoon.components.pipeline.EventPipeline

Parameters:

role - the generator role in the component manager.

source - the source where to produce XML from, or null if no source is given.

param - the parameters for the generator.

Throws:

java.lang.Exception - if the generator couldn't be obtained.

addTransformer

public void addTransformer(java.lang.String role,
                           java.lang.String source,
                           org.apache.avalon.framework.parameters.Parameters param)
                    throws java.lang.Exception

Description copied from class: CachingEventPipeline

Add a transformer.

Overrides:

addTransformer in class CachingEventPipeline

Following copied from interface: org.apache.cocoon.components.pipeline.EventPipeline

Parameters:

role - the transformer role in the component manager.

source - the source used to setup the transformer (e.g. XSL file), or null if no source is given.

param - the parameters for the transfomer.

Throws:

java.lang.Exception - if the generator couldn't be obtained.

process

public boolean process(Environment environment)
                throws java.lang.Exception

Description copied from interface: EventPipeline

Process the given Environment, producing the output.

Overrides:

process in class CachingEventPipeline

recycle

public void recycle()

Description copied from class: AbstractXMLProducer

Recycle the producer by removing references

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class CachingEventPipeline