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:
java.io.Closeable
,java.lang.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
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.List<XSSFRelation>
SUPPORTED_TYPES
-
Constructor Summary
Constructors Constructor Description XSSFBEventBasedExcelExtractor(java.lang.String path)
XSSFBEventBasedExcelExtractor(OPCPackage container)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getText()
Processes the file and returns the textvoid
processSheet(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor, XSSFBStylesTable styles, XSSFBCommentsTable comments, SharedStrings strings, java.io.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
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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.poi.ooxml.extractor.POIXMLTextExtractor
checkMaxTextSize, close, getMetadataTextExtractor
-
-
-
-
Field Detail
-
SUPPORTED_TYPES
public static final java.util.List<XSSFRelation> SUPPORTED_TYPES
-
-
Constructor Detail
-
XSSFBEventBasedExcelExtractor
public XSSFBEventBasedExcelExtractor(java.lang.String path) throws XmlException, OpenXML4JException, java.io.IOException
- Throws:
XmlException
OpenXML4JException
java.io.IOException
-
XSSFBEventBasedExcelExtractor
public XSSFBEventBasedExcelExtractor(OPCPackage container) throws XmlException, OpenXML4JException, java.io.IOException
- Throws:
XmlException
OpenXML4JException
java.io.IOException
-
-
Method Detail
-
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
-
processSheet
public void processSheet(XSSFSheetXMLHandler.SheetContentsHandler sheetContentsExtractor, XSSFBStylesTable styles, XSSFBCommentsTable comments, SharedStrings strings, java.io.InputStream sheetInputStream) throws java.io.IOException
Processes the given sheet- Throws:
java.io.IOException
-
getText
public java.lang.String getText()
Processes the file and returns the text- Specified by:
getText
in interfaceExcelExtractor
- Specified by:
getText
in interfacePOITextExtractor
- Overrides:
getText
in classXSSFEventBasedExcelExtractor
- Returns:
- All the text from the document
-
-