org.apache.cocoon.serialization
Class POIFSSerializer

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.serialization.ElementProcessorSerializer
              |
              +--org.apache.cocoon.serialization.POIFSSerializer

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.Loggable, Serializer, SitemapOutputComponent, XMLConsumer

Direct Known Subclasses:

HSSFSerializer

public abstract class POIFSSerializer

extends ElementProcessorSerializer

An extension of ElementProcessorSerializer with extensions for dealing with the POIFS filesystem This is an abstract class. Concrete extensions need to implement the following methods:

• String getMimeType()
• void doLocalPreEndDocument()
• void doLocalPostEndDocument()
• ElementProcessorFactory getElementProcessorFactory()

Author:

Marc Johnson ([email protected]), Nicola Ken Barozzi ([email protected])

Fields inherited from class org.apache.cocoon.serialization.ElementProcessorSerializer

manager

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

ROLE

Constructor Summary

POIFSSerializer()
Constructor

Method Summary

protected abstract void	doLocalPostEndDocument() Extending classes should do whatever they need to do after writing the filesystem out
protected abstract void	doLocalPreEndDocument() Extending classes should do whatever they need to do prior to writing the filesystem out
protected void	doPreInitialization(ElementProcessor processor) perform pre-initialization on an element processor
void	endDocument() Receive notification of the end of a document.
protected org.apache.poi.poifs.filesystem.POIFSFileSystem	getFilesystem() Provide access to the filesystem for extending classes

Methods inherited from class org.apache.cocoon.serialization.ElementProcessorSerializer

characters, comment, compose, endCDATA, endDTD, endElement, endEntity, endPrefixMapping, getElementProcessorFactory, getOutputStream, ignorableWhitespace, processingInstruction, SAXExceptionFactory, SAXExceptionFactory, setDocumentLocator, setOutputStream, shouldSetContentLength, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping

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.sitemap.SitemapOutputComponent

getMimeType

Constructor Detail

POIFSSerializer

public POIFSSerializer()

Constructor

Method Detail

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Receive notification of the end of a document.

Throws:

org.xml.sax.SAXException - if there is an error writing the document to the output stream

getFilesystem

protected org.apache.poi.poifs.filesystem.POIFSFileSystem getFilesystem()

Provide access to the filesystem for extending classes

Returns:

the filesystem

doLocalPreEndDocument

protected abstract void doLocalPreEndDocument()

Extending classes should do whatever they need to do prior to writing the filesystem out

doLocalPostEndDocument

protected abstract void doLocalPostEndDocument()

Extending classes should do whatever they need to do after writing the filesystem out

doPreInitialization

protected void doPreInitialization(ElementProcessor processor)
                            throws org.xml.sax.SAXException

perform pre-initialization on an element processor

Overrides:

doPreInitialization in class ElementProcessorSerializer

Parameters:

processor - the element processor to be iniitialized

Throws:

org.xml.sax.SAXException - on errors