This project has retired. For details please refer to its Attic page.

org.apache.cocoon.sax.util
Class SAXConsumerAdapter

java.lang.Object
  org.apache.cocoon.xml.sax.AbstractSAXProducer
      org.apache.cocoon.xml.sax.AbstractSAXPipe
          org.apache.cocoon.sax.util.SAXConsumerAdapter

All Implemented Interfaces:

Consumer, PipelineComponent, SAXConsumer, ContentHandler, LexicalHandler

Direct Known Subclasses:

AbstractSAXSerializer

public class SAXConsumerAdapter
extends org.apache.cocoon.xml.sax.AbstractSAXPipe
implements SAXConsumer

Field Summary

Fields inherited from class org.apache.cocoon.xml.sax.AbstractSAXProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler

Constructor Summary

SAXConsumerAdapter()

Method Summary

void	finish() This method is called after pipeline run - regardless if the run was successful or an exception was thrown.
ContentHandler	getContentHandler() Provide access to the ContentHandler used by the adapter.
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 org.apache.cocoon.xml.sax.AbstractSAXPipe

characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.sax.AbstractSAXProducer

recycle, setContentHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Constructor Detail

SAXConsumerAdapter

public SAXConsumerAdapter()

Method Detail

finish

public void finish()

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

Specified by:

finish in interface PipelineComponent

See Also:

PipelineComponent.finish()

getContentHandler

public ContentHandler getContentHandler()

Provide access to the ContentHandler used by the adapter.

Returns:

ContentHandler

setConfiguration

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

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.

See Also:

PipelineComponent.setConfiguration(java.util.Map)

setup

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

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.

See Also:

PipelineComponent.setup(java.util.Map)