org.apache.poi
Class POIOLE2TextExtractor

java.lang.Object
  extended by org.apache.poi.POITextExtractor
      extended by org.apache.poi.POIOLE2TextExtractor
Direct Known Subclasses:
EventBasedExcelExtractor, ExcelExtractor, OutlookTextExtactor, PowerPointExtractor, PublisherTextExtractor, VisioTextExtractor, Word6Extractor, WordExtractor

public abstract class POIOLE2TextExtractor
extends POITextExtractor

Common Parent for OLE2 based Text Extractors of POI Documents, such as .doc, .xls You will typically find the implementation of a given format's text extractor under org.apache.poi.[format].extractor .

See Also:
ExcelExtractor, PowerPointExtractor, VisioTextExtractor, WordExtractor

Field Summary
 
Fields inherited from class org.apache.poi.POITextExtractor
document
 
Constructor Summary
POIOLE2TextExtractor(POIDocument document)
          Creates a new text extractor for the given document
 
Method Summary
 DocumentSummaryInformation getDocSummaryInformation()
          Returns the document information metadata for the document
 POIFSFileSystem getFileSystem()
          Deprecated. Use getRoot() instead
 POITextExtractor getMetadataTextExtractor()
          Returns an HPSF powered text extractor for the document properties metadata, such as title and author.
 DirectoryEntry getRoot()
           
 SummaryInformation getSummaryInformation()
          Returns the summary information metadata for the document
 
Methods inherited from class org.apache.poi.POITextExtractor
getText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

POIOLE2TextExtractor

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

Method Detail

getDocSummaryInformation

public DocumentSummaryInformation getDocSummaryInformation()
Returns the document information metadata for the document


getSummaryInformation

public SummaryInformation getSummaryInformation()
Returns the summary information metadata for the document


getMetadataTextExtractor

public POITextExtractor getMetadataTextExtractor()
Returns an HPSF powered text extractor for the document properties metadata, such as title and author.

Specified by:
getMetadataTextExtractor in class POITextExtractor

getRoot

public DirectoryEntry getRoot()

getFileSystem

@Deprecated
public POIFSFileSystem getFileSystem()
Deprecated. Use getRoot() instead

Return the underlying POIFS FileSystem of this document.



Copyright 2012 The Apache Software Foundation or its licensors, as applicable.