Package org.apache.poi.xssf.eventusermodel

Class XSSFSheetXMLHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XSSFSheetXMLHandler
extends org.xml.sax.helpers.DefaultHandler

This class handles the streaming processing of a sheet#.xml sheet part of a XSSF .xlsx file, and generates row and cell events for it. This allows to build functionality which reads huge files without needing large amounts of main memory. See XSSFSheetXMLHandler.SheetContentsHandler for the interface that you need to implement for reading information from a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	XSSFSheetXMLHandler.SheetContentsHandler	This interface allows to provide callbacks when reading a sheet in streaming mode.

Constructor Summary

Constructors

Constructor	Description
XSSFSheetXMLHandler(Styles styles, Comments comments, SharedStrings strings, XSSFSheetXMLHandler.SheetContentsHandler sheetContentsHandler, DataFormatter dataFormatter, boolean formulasNotResults)	Accepts objects needed while parsing.
XSSFSheetXMLHandler(Styles styles, SharedStrings strings, XSSFSheetXMLHandler.SheetContentsHandler sheetContentsHandler, boolean formulasNotResults)	Accepts objects needed while parsing.
XSSFSheetXMLHandler(Styles styles, SharedStrings strings, XSSFSheetXMLHandler.SheetContentsHandler sheetContentsHandler, DataFormatter dataFormatter, boolean formulasNotResults)	Accepts objects needed while parsing.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Captures characters only if a suitable element is open.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFSheetXMLHandler

public XSSFSheetXMLHandler(Styles styles,
                           Comments comments,
                           SharedStrings strings,
                           XSSFSheetXMLHandler.SheetContentsHandler sheetContentsHandler,
                           DataFormatter dataFormatter,
                           boolean formulasNotResults)

Accepts objects needed while parsing.

Parameters:

styles - Table of styles

strings - Table of shared strings

XSSFSheetXMLHandler

public XSSFSheetXMLHandler(Styles styles,
                           SharedStrings strings,
                           XSSFSheetXMLHandler.SheetContentsHandler sheetContentsHandler,
                           DataFormatter dataFormatter,
                           boolean formulasNotResults)

Accepts objects needed while parsing.

Parameters:

styles - Table of styles

strings - Table of shared strings

XSSFSheetXMLHandler

public XSSFSheetXMLHandler(Styles styles,
                           SharedStrings strings,
                           XSSFSheetXMLHandler.SheetContentsHandler sheetContentsHandler,
                           boolean formulasNotResults)

Accepts objects needed while parsing.

Parameters:

styles - Table of styles

strings - Table of shared strings

Method Detail

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Captures characters only if a suitable element is open. Originally was just "v"; extended for inlineStr also.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException