org.apache.cocoon.serialization
Class POIFSSerializer

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.serialization.ElementProcessorSerializer
          extended by org.apache.cocoon.serialization.POIFSSerializer
All Implemented Interfaces:
Component, LogEnabled, Serviceable, Serializer, SitemapOutputComponent, XMLConsumer, ContentHandler, LexicalHandler
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:

Version:
CVS $Id: POIFSSerializer.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Marc Johnson (marc_johnson27591@hotmail.com), Nicola Ken Barozzi (nicolaken@apache.org)

Field Summary
 
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, endCDATA, endDTD, endElement, endEntity, endPrefixMapping, getElementProcessorFactory, getOutputStream, ignorableWhitespace, processingInstruction, SAXExceptionFactory, SAXExceptionFactory, service, setDocumentLocator, setOutputStream, shouldSetContentLength, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, 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 SAXException
Receive notification of the end of a document.

Throws:
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 SAXException
perform pre-initialization on an element processor

Specified by:
doPreInitialization in class ElementProcessorSerializer
Parameters:
processor - the element processor to be iniitialized
Throws:
SAXException - on errors


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.