Package org.apache.poi.xssf.extractor

Class XSSFBEventBasedExcelExtractor

java.lang.Object

org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor

org.apache.poi.xssf.extractor.XSSFBEventBasedExcelExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, POITextExtractor, POIXMLTextExtractor, ExcelExtractor

public class XSSFBEventBasedExcelExtractor
extends XSSFEventBasedExcelExtractor

Implementation of a text extractor or xlsb Excel files that uses SAX-like binary parsing.

Since:

3.16-beta3

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor

XSSFEventBasedExcelExtractor.SheetTextExtractor

Field Summary

Fields

Modifier and Type	Field	Description
static final List<XSSFRelation>	SUPPORTED_TYPES

Fields inherited from class org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor

concatenatePhoneticRuns, container, formulasNotResults, includeCellComments, includeHeadersFooters, includeSheetNames, includeTextBoxes, locale, properties

Constructor Summary

Constructors

Constructor	Description
XSSFBEventBasedExcelExtractor(String path)
XSSFBEventBasedExcelExtractor(OPCPackage container)

Method Summary

Modifier and Type	Method	Description
String	getText()	Processes the file and returns the text
void	processSheet(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor, XSSFBStylesTable styles, XSSFBCommentsTable comments, SharedStrings 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 This is currently unsupported for xssfb
void	setHandleHyperlinksInCells(boolean handleHyperlinksInCells)	Should the targets of the hyperlinks be added to the text of the cells they cover? The target is appended to the cell text as " <target>", which is the url for external links and the location (e.g.

Methods inherited from class org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor

createSharedStringsTable, getCoreProperties, getCustomProperties, getDocument, getExtendedProperties, getFilesystem, getFormulasNotResults, getIncludeCellComments, getIncludeHeadersFooters, getIncludeSheetNames, getIncludeTextBoxes, getLocale, getPackage, isCloseFilesystem, processSheet, setCloseFilesystem, setConcatenatePhoneticRuns, setIncludeCellComments, setIncludeHeadersFooters, setIncludeSheetNames, setIncludeTextBoxes, setLocale

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, getMetadataTextExtractor

Field Details

SUPPORTED_TYPES

public static final List<XSSFRelation> SUPPORTED_TYPES

Constructor Details

XSSFBEventBasedExcelExtractor

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

Throws:

org.apache.xmlbeans.XmlException

OpenXML4JException

IOException

XSSFBEventBasedExcelExtractor

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

Throws:

org.apache.xmlbeans.XmlException

OpenXML4JException

IOException

Method Details

setHandleHyperlinksInCells

public void setHandleHyperlinksInCells(boolean handleHyperlinksInCells)

Should the targets of the hyperlinks be added to the text of the cells they cover? The target is appended to the cell text as " <target>", which is the url for external links and the location (e.g. Sheet2!A1) for links within the workbook. Default is false.

Parameters:

handleHyperlinksInCells - true to add the hyperlink targets

setFormulasNotResults

public void setFormulasNotResults(boolean formulasNotResults)

Should we return the formula itself, and not the result it produces? Default is false This is currently unsupported for xssfb

Specified by:

setFormulasNotResults in interface ExcelExtractor

Overrides:

setFormulasNotResults in class XSSFEventBasedExcelExtractor

Parameters:

formulasNotResults - true if the formula itself is returned

processSheet

public void processSheet(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor,
 XSSFBStylesTable styles,
 XSSFBCommentsTable comments,
 SharedStrings strings,
 InputStream sheetInputStream)
                  throws IOException

Processes the given sheet

Throws:

IOException

getText

public String getText()

Processes the file and returns the text

Specified by:

getText in interface ExcelExtractor

Specified by:

getText in interface POITextExtractor

Overrides:

getText in class XSSFEventBasedExcelExtractor

Returns:

All the text from the document