Package loci.poi

Class POITextExtractor

  • Direct Known Subclasses:
    ExcelExtractor
    public abstract class POITextExtractor
extends java.lang.Object
    Common Parent for Text Extractors of POI Documents. You will typically find the implementation of a given format's text extractor under loci.poi.[format].extractor .
    See Also:
    ExcelExtractor

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected POIDocument document
      The POIDocument that's open

    • Constructor Summary

      Constructors 
      Constructor Description
      POITextExtractor​(POIDocument document)
      Creates a new text extractor for the given document

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.String getText()
      Retrieves all the text from the document.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • document

        protected POIDocument document
        The POIDocument that's open

    • Constructor Detail

      • POITextExtractor

        public POITextExtractor​(POIDocument document)
        Creates a new text extractor for the given document

    • Method Detail

      • getText

        public abstract java.lang.String getText()
        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.
        Returns:
        All the text from the document