org.apache.cocoon.components.pipeline
Class AbstractEventPipeline

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.components.pipeline.AbstractEventPipeline
All Implemented Interfaces:
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.excalibur.pool.Recyclable, XMLProducer
Direct Known Subclasses:
CachingEventPipeline, NonCachingEventPipeline

public abstract class AbstractEventPipeline
extends AbstractXMLProducer
implements EventPipeline, org.apache.avalon.framework.activity.Disposable

Version:
CVS $Revision: 1.5.2.12 $ $Date: 2001/11/28 11:18:21 $
Author:
Giacomo Pati, Carsten Ziegeler

Field Summary
protected  boolean configuredSAXConnector
          is a SAXConnector configured?
protected  java.util.ArrayList connectors
           
protected  Generator generator
           
protected  org.apache.avalon.framework.parameters.Parameters generatorParam
           
protected  org.apache.avalon.framework.component.ComponentSelector generatorSelector
           
protected  java.lang.String generatorSource
           
protected  org.apache.avalon.framework.component.ComponentManager manager
          the component manager
protected  java.util.ArrayList transformerParams
           
protected  java.util.ArrayList transformers
           
protected  org.apache.avalon.framework.component.ComponentSelector transformerSelector
           
protected  java.util.ArrayList 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
AbstractEventPipeline()
           
 
Method Summary
 void addTransformer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param)
           
protected  boolean checkPipeline()
          Sanity check the non-reader pipeline.
 void compose(org.apache.avalon.framework.component.ComponentManager manager)
           
protected  void connectPipeline(Environment environment)
          Connect the pipeline.
 void dispose()
           
 Generator getGenerator()
           
 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)
           
 void setGenerator(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param, java.lang.Exception e)
           
protected  void setupPipeline(Environment environment)
          Setup pipeline components.
 
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
 

Field Detail

generator

protected Generator generator

generatorParam

protected org.apache.avalon.framework.parameters.Parameters generatorParam

generatorSource

protected java.lang.String generatorSource

generatorSelector

protected org.apache.avalon.framework.component.ComponentSelector generatorSelector

transformerSelector

protected org.apache.avalon.framework.component.ComponentSelector transformerSelector

transformers

protected java.util.ArrayList transformers

transformerParams

protected java.util.ArrayList transformerParams

transformerSources

protected java.util.ArrayList transformerSources

connectors

protected java.util.ArrayList connectors

manager

protected org.apache.avalon.framework.component.ComponentManager manager
the component manager

configuredSAXConnector

protected boolean configuredSAXConnector
is a SAXConnector configured?
Constructor Detail

AbstractEventPipeline

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

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
Specified by:
setGenerator in interface EventPipeline

setGenerator

public void setGenerator(java.lang.String role,
                         java.lang.String source,
                         org.apache.avalon.framework.parameters.Parameters param)
                  throws java.lang.Exception
Specified by:
setGenerator in interface EventPipeline

getGenerator

public Generator getGenerator()
Specified by:
getGenerator in interface EventPipeline

addTransformer

public void addTransformer(java.lang.String role,
                           java.lang.String source,
                           org.apache.avalon.framework.parameters.Parameters param)
                    throws java.lang.Exception
Specified by:
addTransformer in interface EventPipeline

process

public boolean process(Environment environment)
                throws java.lang.Exception
Description copied from interface: EventPipeline
Process the given Environment producing the output
Specified by:
process in interface EventPipeline

checkPipeline

protected boolean checkPipeline()
Sanity check the non-reader pipeline.
Returns:
true if the pipeline is 'sane', false otherwise.

setupPipeline

protected void setupPipeline(Environment environment)
                      throws ProcessingException
Setup pipeline components.

connectPipeline

protected void connectPipeline(Environment environment)
                        throws ProcessingException
Connect the pipeline.

dispose

public void dispose()
Specified by:
dispose in interface org.apache.avalon.framework.activity.Disposable

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 AbstractXMLProducer


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.