org.apache.cocoon.pipeline.component
Class AbstractPipelineComponent

java.lang.Object
  org.apache.cocoon.pipeline.component.AbstractPipelineComponent

All Implemented Interfaces:

PipelineComponent

Direct Known Subclasses:

AbstractReader, AbstractSAXPipelineComponent, AbstractStAXPipelineComponent, RedirectorComponent, SpringControllerComponent, StAXToSAXPipelineAdapter, StringTemplateReader, XMLSerializer

public abstract class AbstractPipelineComponent
extends Object
implements PipelineComponent

A basic implementation of a PipelineComponent that provides empty implementations of all its methods.

Constructor Summary

AbstractPipelineComponent()

Method Summary

void	finish() This method is called after pipeline run - regardless if the run was successful or an exception was thrown.
void	setConfiguration(Map<String,? extends Object> configuration) Pass component specific configuration parameters to the pipeline component in a generic way.
void	setup(Map<String,Object> parameters) The shared object map for this pipeline run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPipelineComponent

public AbstractPipelineComponent()

Method Detail

finish

public void finish()

Description copied from interface: PipelineComponent

This method is called after pipeline run - regardless if the run was successful or an exception was thrown.

Specified by:

finish in interface PipelineComponent

setConfiguration

public void setConfiguration(Map<String,? extends Object> configuration)

Description copied from interface: PipelineComponent

Pass component specific configuration parameters to the pipeline component in a generic way. This is useful in environments that automatically assemble pipelines with their components and can't use the components constructors or setters.

Specified by:

setConfiguration in interface PipelineComponent

Parameters:

configuration - The Map of configuration parameters.

setup

public void setup(Map<String,Object> parameters)

Description copied from interface: PipelineComponent

The shared object map for this pipeline run.

Specified by:

setup in interface PipelineComponent

Parameters:

parameters - A Map of parameters that are available to all PipelineComponents. This is a modifiable map that can be changed by this pipeline component.