org.apache.cocoon.components.pipeline
Interface StreamPipeline

All Superinterfaces:
org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.framework.component.Recomposable, org.apache.avalon.excalibur.pool.Recyclable
All Known Implementing Classes:
AbstractStreamPipeline

public interface StreamPipeline
extends org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Recomposable, org.apache.avalon.excalibur.pool.Recyclable

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

Version:
CVS $Id: StreamPipeline.java,v 1.4 2002/02/22 07:00:11 cziegeler Exp $
Author:
Giacomo Pati

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 EventPipeline getEventPipeline()
          Get the EventPipeline
 boolean process(Environment environment)
          Process the given Environment producing the output
 void setEventPipeline(EventPipeline eventPipeline)
          Set the EventPipeline
 void setReader(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param)
          Set the reader for this pipeline
 void setReader(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param, java.lang.String mimeType)
          Set the reader for this pipeline
 void setSerializer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param)
          Set the serializer for this pipeline
 void setSerializer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param, java.lang.String mimeType)
          Set the serializer for this pipeline
 
Methods inherited from interface org.apache.avalon.framework.component.Recomposable
recompose
 
Methods inherited from interface org.apache.avalon.framework.component.Composable
compose
 
Methods inherited from interface org.apache.avalon.excalibur.pool.Recyclable
recycle
 

Field Detail

ROLE

public static final java.lang.String ROLE
See Also:
Constant Field Values
Method Detail

process

public boolean process(Environment environment)
                throws java.lang.Exception
Process the given Environment producing the output

java.lang.Exception

setEventPipeline

public void setEventPipeline(EventPipeline eventPipeline)
                      throws java.lang.Exception
Set the EventPipeline

java.lang.Exception

getEventPipeline

public EventPipeline getEventPipeline()
Get the EventPipeline


setReader

public void setReader(java.lang.String role,
                      java.lang.String source,
                      org.apache.avalon.framework.parameters.Parameters param)
               throws java.lang.Exception
Set the reader for this pipeline

java.lang.Exception

setReader

public void setReader(java.lang.String role,
                      java.lang.String source,
                      org.apache.avalon.framework.parameters.Parameters param,
                      java.lang.String mimeType)
               throws java.lang.Exception
Set the reader for this pipeline

java.lang.Exception

setSerializer

public void setSerializer(java.lang.String role,
                          java.lang.String source,
                          org.apache.avalon.framework.parameters.Parameters param)
                   throws java.lang.Exception
Set the serializer for this pipeline

java.lang.Exception

setSerializer

public void setSerializer(java.lang.String role,
                          java.lang.String source,
                          org.apache.avalon.framework.parameters.Parameters param,
                          java.lang.String mimeType)
                   throws java.lang.Exception
Set the serializer for this pipeline

java.lang.Exception


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