org.apache.poi

Class POIOLE2TextExtractor

java.lang.Object

org.apache.poi.POITextExtractor

org.apache.poi.POIOLE2TextExtractor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

EventBasedExcelExtractor, ExcelExtractor

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, org.apache.poi.hslf.extractor.PowerPointExtractor, org.apache.poi.hdgf.extractor.VisioTextExtractor, org.apache.poi.hwpf.extractor.WordExtractor

Constructor Summary

Constructors

Constructor and Description
POIOLE2TextExtractor(POIDocument document) Creates a new text extractor for the given document

Method Summary

Modifier and Type	Method and Description
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() Return the underlying DirectoryEntry of this document.
SummaryInformation	getSummaryInformation() Returns the summary information metadata for the document.

Methods inherited from class org.apache.poi.POITextExtractor

close, getText

Methods inherited from class java.lang.Object

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

Constructor Detail

POIOLE2TextExtractor

public POIOLE2TextExtractor(POIDocument document)

Creates a new text extractor for the given document

Parameters:

document - The POIDocument to use in this extractor.

Method Detail

getDocSummaryInformation

public DocumentSummaryInformation getDocSummaryInformation()

Returns the document information metadata for the document

Returns:

The Document Summary Information or null if it could not be read for this document.

getSummaryInformation

public SummaryInformation getSummaryInformation()

Returns the summary information metadata for the document.

Returns:

The Summary information for the document or null if it could not be read for this 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

Returns:

an instance of POIExtractor that can extract meta-data.

getRoot

public DirectoryEntry getRoot()

Return the underlying DirectoryEntry of this document.

Returns:

the DirectoryEntry that is associated with the POIDocument of this extractor.

getFileSystem

@Deprecated
public POIFSFileSystem getFileSystem()

Deprecated. Use getRoot() instead

Return the underlying POIFS FileSystem of this document.

Returns:

the POIFSFileSystem that is associated with the POIDocument of this extractor.