org.apache.cocoon.serialization
Class AbstractSerializer

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.xml.AbstractXMLPipe
                    |
                    +--org.apache.cocoon.serialization.AbstractSerializer

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, Serializer, SitemapOutputComponent, XMLConsumer, XMLPipe, XMLProducer

Direct Known Subclasses:

AbstractTextSerializer, FOPSerializer, ZipArchiveSerializer

public abstract class AbstractSerializer

extends AbstractXMLPipe

implements Serializer

Version:

CVS $Id: AbstractSerializer.java,v 1.5 2002/02/22 07:03:55 cziegeler Exp $

Author:

Pierpaolo Fumagalli (Apache Software Foundation, Exoffice Technologies), Stefano Mazzocchi

Field Summary

protected java.io.OutputStream

output The OutputStream used by this serializer.

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.serialization.Serializer

ROLE

Constructor Summary

AbstractSerializer()

Method Summary

java.lang.String	getMimeType() Get the mime-type of the output of this Serializer This default implementation returns null to indicate that the mime-type specified in the sitemap is to be used
void	recycle() Recycle serializer by removing references
void	setOutputStream(java.io.OutputStream out) Set the OutputStream where the XML should be serialized.
boolean	shouldSetContentLength() Test if the component wants to set the content length

Methods inherited from class org.apache.cocoon.xml.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.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.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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

output

protected java.io.OutputStream output

The OutputStream used by this serializer.

Constructor Detail

AbstractSerializer

public AbstractSerializer()

Method Detail

setOutputStream

public void setOutputStream(java.io.OutputStream out)

Set the OutputStream where the XML should be serialized.

Specified by:

setOutputStream in interface SitemapOutputComponent

getMimeType

public java.lang.String getMimeType()

Get the mime-type of the output of this Serializer This default implementation returns null to indicate that the mime-type specified in the sitemap is to be used

Specified by:

getMimeType in interface SitemapOutputComponent

recycle

public void recycle()

Recycle serializer by removing references

Overrides:

recycle in class AbstractXMLProducer

shouldSetContentLength

public boolean shouldSetContentLength()

Test if the component wants to set the content length

Specified by:

shouldSetContentLength in interface SitemapOutputComponent