org.apache.poi.xssf.extractor

Class XSSFEventBasedExcelExtractor

java.lang.Object

org.apache.poi.POITextExtractor

org.apache.poi.POIXMLTextExtractor

org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor

All Implemented Interfaces:

Closeable, AutoCloseable

public class XSSFEventBasedExcelExtractor
extends POIXMLTextExtractor

Implementation of a text extractor from OOXML Excel files that uses SAX event based parsing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XSSFEventBasedExcelExtractor.SheetTextExtractor

Field Summary

Fields inherited from class org.apache.poi.POITextExtractor

document

Constructor Summary

Constructors

Constructor and Description
XSSFEventBasedExcelExtractor(OPCPackage container)
XSSFEventBasedExcelExtractor(String path)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
POIXMLProperties.CoreProperties	getCoreProperties() Returns the core document properties
POIXMLProperties.CustomProperties	getCustomProperties() Returns the custom document properties
POIXMLProperties.ExtendedProperties	getExtendedProperties() Returns the extended document properties
OPCPackage	getPackage() Returns the opened OPCPackage container.
String	getText() Processes the file and returns the text
static void	main(String[] args)
void	processSheet(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor, StylesTable styles, ReadOnlySharedStringsTable strings, InputStream sheetInputStream) Processes the given sheet
void	setFormulasNotResults(boolean formulasNotResults) Should we return the formula itself, and not the result it produces? Default is false
void	setIncludeSheetNames(boolean includeSheetNames) Should sheet names be included? Default is true
void	setIncludeTextBoxes(boolean includeTextBoxes) Should text from textboxes be included? Default is true
void	setLocale(Locale locale)

Methods inherited from class org.apache.poi.POIXMLTextExtractor

getDocument, getMetadataTextExtractor

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFEventBasedExcelExtractor

public XSSFEventBasedExcelExtractor(String path)
                             throws org.apache.xmlbeans.XmlException,
                                    OpenXML4JException,
                                    IOException

Throws:

org.apache.xmlbeans.XmlException

OpenXML4JException

IOException

XSSFEventBasedExcelExtractor

public XSSFEventBasedExcelExtractor(OPCPackage container)
                             throws org.apache.xmlbeans.XmlException,
                                    OpenXML4JException,
                                    IOException

Throws:

org.apache.xmlbeans.XmlException

OpenXML4JException

IOException

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

setIncludeSheetNames

public void setIncludeSheetNames(boolean includeSheetNames)

Should sheet names be included? Default is true

setFormulasNotResults

public void setFormulasNotResults(boolean formulasNotResults)

Should we return the formula itself, and not the result it produces? Default is false

setIncludeTextBoxes

public void setIncludeTextBoxes(boolean includeTextBoxes)

Should text from textboxes be included? Default is true

setLocale

public void setLocale(Locale locale)

getPackage

public OPCPackage getPackage()

Returns the opened OPCPackage container.

Overrides:

getPackage in class POIXMLTextExtractor

getCoreProperties

public POIXMLProperties.CoreProperties getCoreProperties()

Returns the core document properties

Overrides:

getCoreProperties in class POIXMLTextExtractor

getExtendedProperties

public POIXMLProperties.ExtendedProperties getExtendedProperties()

Returns the extended document properties

Overrides:

getExtendedProperties in class POIXMLTextExtractor

getCustomProperties

public POIXMLProperties.CustomProperties getCustomProperties()

Returns the custom document properties

Overrides:

getCustomProperties in class POIXMLTextExtractor

processSheet

public void processSheet(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor,
                StylesTable styles,
                ReadOnlySharedStringsTable strings,
                InputStream sheetInputStream)
                  throws IOException,
                         SAXException

Processes the given sheet

Throws:

IOException

SAXException

getText

public String getText()

Processes the file and returns the text

Specified by:

getText in class POITextExtractor

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class POIXMLTextExtractor

Throws:

IOException