org.apache.cocoon.pipeline.component.sax
Class AbstractSerializer

java.lang.Object
  extended by org.apache.cocoon.pipeline.component.sax.XMLConsumerAdapter
      extended by org.apache.cocoon.pipeline.util.AbstractXMLPipe
          extended by org.apache.cocoon.pipeline.component.sax.AbstractSerializer
All Implemented Interfaces:
Consumer, Finisher, PipelineComponent, XMLConsumer, ContentHandler, LexicalHandler
Direct Known Subclasses:
ServletServiceSerializer, XMLSerializer

public abstract class AbstractSerializer
extends AbstractXMLPipe
implements PipelineComponent, Finisher


Field Summary
 
Fields inherited from class org.apache.cocoon.pipeline.component.sax.XMLConsumerAdapter
consumer, contentHandler, lexicalHandler
 
Constructor Summary
AbstractSerializer()
           
 
Method Summary
 void finish(Exception exception)
          This method is called after pipeline run - regardless if the run was successful or an exception was thrown.
protected  Map<String,? extends Object> getConfiguration()
           
 String getContentType()
          
protected  Map<String,Object> getInputParameters()
           
protected  OutputStream getOutputStream()
           
 void setConfiguration(Map<String,? extends Object> configuration)
          
 void setContentType(String contentType)
           
 void setOutputStream(OutputStream outputStream)
          
 void setup(Map<String,Object> inputParameters)
          The shared object map for this pipeline run.
 String toString()
          
 
Methods inherited from class org.apache.cocoon.pipeline.util.AbstractXMLPipe
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.pipeline.component.sax.XMLConsumerAdapter
setConsumer, setContentHandler, setLexicalHandler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractSerializer

public AbstractSerializer()
Method Detail

getConfiguration

protected Map<String,? extends Object> getConfiguration()
Returns:
A Map that contains all configuration parameters.

getContentType

public String getContentType()

Specified by:
getContentType in interface Finisher
See Also:
Finisher.getContentType()

getInputParameters

protected Map<String,Object> getInputParameters()
Returns:
A Map that contains all pipeline input parameters.

getOutputStream

protected OutputStream getOutputStream()
Returns:
The OutputStream of the pipeline.

setConfiguration

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

Specified by:
setConfiguration in interface PipelineComponent
See Also:
PipelineComponent.setConfiguration(java.util.Map)

setContentType

public void setContentType(String contentType)
Parameters:
The - type of the content produced by this serializer.

setup

public void setup(Map<String,Object> inputParameters)
The shared object map for this pipeline run.

Specified by:
setup in interface PipelineComponent
Parameters:
inputParameters - 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)

finish

public void finish(Exception exception)
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(java.lang.Exception)

setOutputStream

public void setOutputStream(OutputStream outputStream)

Specified by:
setOutputStream in interface Finisher
See Also:
Finisher.setOutputStream(java.io.OutputStream)

toString

public String toString()

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright © 2008 The Apache Software Foundation. All Rights Reserved.