|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.avalon.framework.logger.AbstractLoggable | +--org.apache.cocoon.xml.AbstractXMLProducer | +--org.apache.cocoon.components.pipeline.AbstractEventPipeline
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 set with compose() |
protected org.apache.avalon.framework.component.ComponentManager |
newManager
the component manager set with compose() and recompose() |
protected java.util.ArrayList |
transformerParams
|
protected java.util.ArrayList |
transformers
|
protected java.util.ArrayList |
transformerSelectors
|
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)
Add a transformer at the end of the pipeline. |
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()
Get the generator used by this pipeline. |
boolean |
process(Environment environment)
Process the given Environment , producing the output. |
void |
recompose(org.apache.avalon.framework.component.ComponentManager manager)
|
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 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. |
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 |
Methods inherited from interface org.apache.cocoon.xml.XMLProducer |
setConsumer |
Field Detail |
protected Generator generator
protected org.apache.avalon.framework.parameters.Parameters generatorParam
protected java.lang.String generatorSource
protected org.apache.avalon.framework.component.ComponentSelector generatorSelector
protected java.util.ArrayList transformers
protected java.util.ArrayList transformerParams
protected java.util.ArrayList transformerSources
protected java.util.ArrayList transformerSelectors
protected java.util.ArrayList connectors
protected org.apache.avalon.framework.component.ComponentManager manager
protected boolean configuredSAXConnector
protected org.apache.avalon.framework.component.ComponentManager newManager
Constructor Detail |
public AbstractEventPipeline()
Method Detail |
public void compose(org.apache.avalon.framework.component.ComponentManager manager) throws org.apache.avalon.framework.component.ComponentException
compose
in interface org.apache.avalon.framework.component.Composable
org.apache.avalon.framework.component.ComponentException
public void recompose(org.apache.avalon.framework.component.ComponentManager manager) throws org.apache.avalon.framework.component.ComponentException
recompose
in interface org.apache.avalon.framework.component.Recomposable
org.apache.avalon.framework.component.ComponentException
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
EventPipeline
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.
setGenerator
in interface EventPipeline
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 void setGenerator(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param) throws java.lang.Exception
EventPipeline
Generator
is fetched
from the latest ComponentManager
given by compose()
or recompose()
.
setGenerator
in interface EventPipeline
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 Generator getGenerator()
EventPipeline
getGenerator
in interface EventPipeline
public void addTransformer(java.lang.String role, java.lang.String source, org.apache.avalon.framework.parameters.Parameters param) throws java.lang.Exception
EventPipeline
Transformer
is fetched
from the latest ComponentManager
given by compose()
or recompose()
.
addTransformer
in interface EventPipeline
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.public boolean process(Environment environment) throws java.lang.Exception
EventPipeline
Environment
, producing the output.
process
in interface EventPipeline
java.lang.Exception
protected boolean checkPipeline()
protected void setupPipeline(Environment environment) throws ProcessingException
ProcessingException
protected void connectPipeline(Environment environment) throws ProcessingException
ProcessingException
public void recycle()
AbstractXMLProducer
recycle
in interface org.apache.avalon.excalibur.pool.Recyclable
recycle
in class AbstractXMLProducer
public void dispose()
dispose
in interface org.apache.avalon.framework.activity.Disposable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |