Package org.apache.poi.xssf.extractor
Class XSSFBEventBasedExcelExtractor
java.lang.Object
org.apache.poi.extractor.POITextExtractor
org.apache.poi.ooxml.extractor.POIXMLTextExtractor
org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor
org.apache.poi.xssf.extractor.XSSFBEventBasedExcelExtractor
- All Implemented Interfaces:
Closeable
,AutoCloseable
,ExcelExtractor
public class XSSFBEventBasedExcelExtractor
extends XSSFEventBasedExcelExtractor
implements ExcelExtractor
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
FieldsFields inherited from class org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor
concatenatePhoneticRuns, container, formulasNotResults, includeCellComments, includeHeadersFooters, includeSheetNames, includeTextBoxes, locale, properties
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetText()
Processes the file and returns the textstatic void
void
processSheet
(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor, XSSFBStylesTable styles, XSSFBCommentsTable comments, SharedStrings strings, InputStream sheetInputStream) Processes the given sheetvoid
setFormulasNotResults
(boolean formulasNotResults) Should we return the formula itself, and not the result it produces? Default is false This is currently unsupported for xssfbvoid
setHandleHyperlinksInCells
(boolean handleHyperlinksInCells) Methods inherited from class org.apache.poi.xssf.extractor.XSSFEventBasedExcelExtractor
close, createSharedStringsTable, getCoreProperties, getCustomProperties, getExtendedProperties, getFormulasNotResults, getIncludeCellComments, getIncludeHeadersFooters, getIncludeSheetNames, getIncludeTextBoxes, getLocale, getPackage, processSheet, setConcatenatePhoneticRuns, setIncludeCellComments, setIncludeHeadersFooters, setIncludeSheetNames, setIncludeTextBoxes, setLocale
Methods inherited from class org.apache.poi.ooxml.extractor.POIXMLTextExtractor
checkMaxTextSize, getDocument, getMetadataTextExtractor
Methods inherited from class org.apache.poi.extractor.POITextExtractor
setFilesystem
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.ss.extractor.ExcelExtractor
setIncludeCellComments, setIncludeHeadersFooters, setIncludeSheetNames
-
Field Details
-
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
-
main
- Throws:
Exception
-
setHandleHyperlinksInCells
public void setHandleHyperlinksInCells(boolean handleHyperlinksInCells) -
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 interfaceExcelExtractor
- Overrides:
setFormulasNotResults
in classXSSFEventBasedExcelExtractor
- Parameters:
formulasNotResults
-true
if the formula itself is returned
-
getText
Processes the file and returns the text- Specified by:
getText
in interfaceExcelExtractor
- Overrides:
getText
in classXSSFEventBasedExcelExtractor
- Returns:
- All the text from the document
-