Class POIXMLPropertiesTextExtractor

All Implemented Interfaces:
Closeable, AutoCloseable

public class POIXMLPropertiesTextExtractor extends POIXMLTextExtractor
A POITextExtractor for returning the textual content of the OOXML file properties, eg author and title.
  • Constructor Details

    • POIXMLPropertiesTextExtractor

      public POIXMLPropertiesTextExtractor(POIXMLDocument doc)
      Creates a new POIXMLPropertiesTextExtractor for the given open document.
      Parameters:
      doc - the given open document
    • POIXMLPropertiesTextExtractor

      public POIXMLPropertiesTextExtractor(POIXMLTextExtractor otherExtractor)
      Creates a new POIXMLPropertiesTextExtractor, for the same file that another TextExtractor is already working on.
      Parameters:
      otherExtractor - the extractor referencing the given file
  • Method Details

    • getCorePropertiesText

      public String getCorePropertiesText()
      Returns the core document properties, eg author
      Returns:
      the core document properties
    • getExtendedPropertiesText

      public String getExtendedPropertiesText()
      Returns the extended document properties, eg application
      Returns:
      the extended document properties
    • getCustomPropertiesText

      public String getCustomPropertiesText()
      Returns the custom document properties, if there are any
      Returns:
      the custom document properties
    • getText

      public String getText()
      Description copied from class: POITextExtractor
      Retrieves all the text from the document. How cells, paragraphs etc are separated in the text is implementation specific - see the javadocs for a specific project for details.
      Specified by:
      getText in class POITextExtractor
      Returns:
      All the text from the document
    • getMetadataTextExtractor

      public POIXMLPropertiesTextExtractor getMetadataTextExtractor()
      Description copied from class: POIXMLTextExtractor
      Returns an OOXML properties text extractor for the document properties metadata, such as title and author.
      Overrides:
      getMetadataTextExtractor in class POIXMLTextExtractor
      Returns:
      the metadata and text extractor