org.apache.poi.xssf.extractor

Class XSSFExcelExtractor

java.lang.Object

org.apache.poi.xssf.extractor.XSSFExcelExtractor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, POITextExtractor, POIXMLTextExtractor, ExcelExtractor

public class XSSFExcelExtractor
extends java.lang.Object
implements POIXMLTextExtractor, ExcelExtractor

Helper class to extract text from an OOXML Excel file

Field Summary

Fields

Modifier and Type	Field and Description
static XSSFRelation[]	SUPPORTED_TYPES

Constructor Summary

Constructors

Constructor and Description
XSSFExcelExtractor(OPCPackage container)
XSSFExcelExtractor(XSSFWorkbook workbook)

Method Summary

Modifier and Type	Method and Description
XSSFWorkbook	getDocument() Returns opened document
XSSFWorkbook	getFilesystem()
java.lang.String	getText() Retrieves the text contents of the file
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)
void	setFormulasNotResults(boolean formulasNotResults) Should we return the formula itself, and not the result it produces? Default is false
void	setIncludeCellComments(boolean includeCellComments) Should cell comments be included? Default is false
void	setIncludeHeadersFooters(boolean includeHeadersFooters) Should headers and footers be included? Default is true
void	setIncludeSheetNames(boolean includeSheetNames) Should sheet names be included? Default is true
void	setIncludeTextBoxes(boolean includeTextBoxes) Should text within textboxes be included? Default is true
void	setLocale(java.util.Locale locale) What Locale should be used for formatting numbers (based on the styles applied to the cells)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.ooxml.extractor.POIXMLTextExtractor

checkMaxTextSize, close, getCoreProperties, getCustomProperties, getExtendedProperties, getMetadataTextExtractor, getPackage

Field Detail

SUPPORTED_TYPES

public static final XSSFRelation[] SUPPORTED_TYPES

Constructor Detail

XSSFExcelExtractor

public XSSFExcelExtractor(OPCPackage container)
                   throws org.apache.xmlbeans.XmlException,
                          OpenXML4JException,
                          java.io.IOException

Throws:

org.apache.xmlbeans.XmlException

OpenXML4JException

java.io.IOException

XSSFExcelExtractor

public XSSFExcelExtractor(XSSFWorkbook workbook)

Method Detail

setIncludeSheetNames

public void setIncludeSheetNames(boolean includeSheetNames)

Should sheet names be included? Default is true

Specified by:

setIncludeSheetNames in interface ExcelExtractor

Parameters:

includeSheetNames - true if the sheet names should be included

setFormulasNotResults

public void setFormulasNotResults(boolean formulasNotResults)

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

Specified by:

setFormulasNotResults in interface ExcelExtractor

Parameters:

formulasNotResults - true if the formula itself is returned

setIncludeCellComments

public void setIncludeCellComments(boolean includeCellComments)

Should cell comments be included? Default is false

Specified by:

setIncludeCellComments in interface ExcelExtractor

Parameters:

includeCellComments - true if cell comments should be included

setIncludeHeadersFooters

public void setIncludeHeadersFooters(boolean includeHeadersFooters)

Should headers and footers be included? Default is true

Specified by:

setIncludeHeadersFooters in interface ExcelExtractor

Parameters:

includeHeadersFooters - true if headers and footers should be included

setIncludeTextBoxes

public void setIncludeTextBoxes(boolean includeTextBoxes)

Should text within textboxes be included? Default is true

Parameters:

includeTextBoxes - True if textboxes should be included, false if not.

setLocale

public void setLocale(java.util.Locale locale)

What Locale should be used for formatting numbers (based on the styles applied to the cells)

getText

public java.lang.String getText()

Retrieves the text contents of the file

Specified by:

getText in interface POITextExtractor

Specified by:

getText in interface ExcelExtractor

Returns:

All the text from the document

getDocument

public XSSFWorkbook getDocument()

Description copied from interface: POIXMLTextExtractor

Returns opened document

Specified by:

getDocument in interface POITextExtractor

Specified by:

getDocument in interface POIXMLTextExtractor

Returns:

the opened document

setCloseFilesystem

public void setCloseFilesystem(boolean doCloseFilesystem)

Specified by:

setCloseFilesystem in interface POITextExtractor

Parameters:

doCloseFilesystem - true (default), if underlying resources/filesystem should be closed on POITextExtractor.close()

isCloseFilesystem

public boolean isCloseFilesystem()

Specified by:

isCloseFilesystem in interface POITextExtractor

Returns:

true, if resources/filesystem should be closed on POITextExtractor.close()

getFilesystem

public XSSFWorkbook getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem