Save This Page
Home » cocoon-2.1.11-src » org.apache » cocoon » components » pipeline » [javadoc | source]
org.apache.cocoon.components.pipeline
public interface: StreamPipeline [javadoc | source]

All Implemented Interfaces:
    org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Recomposable

All Known Implementing Classes:
    AbstractStreamPipeline, NonCachingStreamPipeline, CachingStreamPipeline

A StreamPipeline either

A StreamPipeline is Recomposable since the ComponentManager used to get the reader or serializer depends on the pipeline assembly engine where they are defined (i.e. a given sitemap file).

Field Summary
 String ROLE     
Method from org.apache.cocoon.components.pipeline.StreamPipeline Summary:
getEventPipeline,   process,   setEventPipeline,   setReader,   setReader,   setSerializer,   setSerializer
Method from org.apache.cocoon.components.pipeline.StreamPipeline Detail:
 public EventPipeline getEventPipeline()
    Get the EventPipeline
 public boolean process(Environment environment) throws Exception
    Process the given Environment producing the output
 public  void setEventPipeline(EventPipeline eventPipeline) throws Exception
    Set the EventPipeline
 public  void setReader(String role,
    String source,
    Parameters param) throws Exception
    Set the reader for this pipeline
 public  void setReader(String role,
    String source,
    Parameters param,
    String mimeType) throws Exception
    Set the reader for this pipeline
 public  void setSerializer(String role,
    String source,
    Parameters param) throws Exception
    Set the serializer for this pipeline
 public  void setSerializer(String role,
    String source,
    Parameters param,
    String mimeType) throws Exception
    Set the serializer for this pipeline