Package org.apache.poi.ooxml.extractor

Interface POIXMLTextExtractor

All Superinterfaces:
AutoCloseable, Closeable, POITextExtractor
All Known Implementing Classes:
POIXMLPropertiesTextExtractor, XDGFVisioExtractor, XPSTextExtractor, XSLFEventBasedPowerPointExtractor, XSLFExtractor, XSSFBEventBasedExcelExtractor, XSSFEventBasedExcelExtractor, XSSFExcelExtractor, XWPFEventBasedWordExtractor, XWPFWordExtractor
public interface POIXMLTextExtractor extends POITextExtractor

  • Method Details

    • getCoreProperties

      default POIXMLProperties.CoreProperties getCoreProperties()
      Returns the core document properties
      Returns:
      the core document properties

    • getExtendedProperties

      default POIXMLProperties.ExtendedProperties getExtendedProperties()
      Returns the extended document properties
      Returns:
      the extended document properties

    • getCustomProperties

      default POIXMLProperties.CustomProperties getCustomProperties()
      Returns the custom document properties
      Returns:
      the custom document properties

    • getDocument

      POIXMLDocument getDocument()
      Returns opened document
      Specified by:
      getDocument in interface POITextExtractor
      Returns:
      the opened document

    • getPackage

      default OPCPackage getPackage()
      Returns the opened OPCPackage that contains the document
      Returns:
      the opened OPCPackage

    • getMetadataTextExtractor

      default POIXMLPropertiesTextExtractor getMetadataTextExtractor()
      Returns an OOXML properties text extractor for the document properties metadata, such as title and author.
      Specified by:
      getMetadataTextExtractor in interface POITextExtractor
      Returns:
      the metadata and text extractor

    • close

      default void close() throws IOException
      Description copied from interface: POITextExtractor
      Allows to free resources of the Extractor as soon as it is not needed any more. This may include closing open file handles and freeing memory. The Extractor cannot be used after close has been called.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface POITextExtractor
      Throws:
      IOException

    • checkMaxTextSize

      default void checkMaxTextSize(CharSequence text, String string)