Package org.apache.poi.xssf.extractor

Class XSSFExcelExtractor

java.lang.Object
org.apache.poi.xssf.extractor.XSSFExcelExtractor
All Implemented Interfaces:
Closeable, AutoCloseable, POITextExtractor, POIXMLTextExtractor, ExcelExtractor
public class XSSFExcelExtractor extends Object implements POIXMLTextExtractor, ExcelExtractor
Helper class to extract text from an OOXML Excel file

  • Field Details

  • Constructor Details

  • Method Details

    • 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(Locale locale)
      What Locale should be used for formatting numbers (based on the styles applied to the cells)

    • getText

      public String getText()
      Retrieves the text contents of the file
      Specified by:
      getText in interface ExcelExtractor
      Specified by:
      getText in interface POITextExtractor
      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