|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A pipeline that produces SAX events using a Generator
and
zero or more Transformer
s.
An EventPipeline
is Recomposable
since the
ComponentManager
used to get the generator and transformers
depends on the pipeline assembly engine where they are defined (i.e. a given
sitemap file).
Field Summary | |
static java.lang.String |
ROLE
|
Method Summary | |
void |
addTransformer(java.lang.String role,
java.lang.String source,
org.apache.avalon.framework.parameters.Parameters param)
Add a transformer at the end of the pipeline. |
Generator |
getGenerator()
Get the generator used by this pipeline. |
boolean |
process(Environment environment)
Process the given Environment , producing the output. |
void |
setGenerator(java.lang.String role,
java.lang.String source,
org.apache.avalon.framework.parameters.Parameters param)
Set the generator that will be used as the initial step in the pipeline. |
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 interface org.apache.cocoon.xml.XMLProducer |
setConsumer |
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 |
public static final java.lang.String ROLE
Method Detail |
public boolean process(Environment environment) throws java.lang.Exception
Environment
, producing the output.
java.lang.Exception
public void setGenerator(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param) throws java.lang.Exception
Generator
is fetched
from the latest ComponentManager
given by compose()
or recompose()
.
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.
java.lang.Exception
- if the generator couldn't be obtained.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
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.
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.
java.lang.Exception
- if the generator couldn't be obtained.ErrorNotifier
public Generator getGenerator()
public void addTransformer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param) throws java.lang.Exception
Transformer
is fetched
from the latest ComponentManager
given by compose()
or recompose()
.
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.
java.lang.Exception
- if the generator couldn't be obtained.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |