Top Description Methods
org.apache.poi.extractor

public Interface POIOLE2TextExtractor

extends POITextExtractor
Known Direct Implementers
org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor, org.apache.poi.hssf.extractor.EventBasedExcelExtractor, org.apache.poi.hssf.extractor.ExcelExtractor
Imports
org.apache.poi.POIDocument, org.apache.poi.hpsf.DocumentSummaryInformation, .SummaryInformation, org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor, org.apache.poi.poifs.filesystem.DirectoryEntry
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
org.apache.poi.hssf.extractor.ExcelExtractor, org.apache.poi.hdgf.extractor.VisioTextExtractor, org.apache.poi.hwpf.extractor.WordExtractor

Method Summary

Modifier and TypeMethod and Description
public default DocumentSummaryInformation

Returns:

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

Returns the document information metadata for the document

public POIDocument

Returns:

the underlying POIDocument
getDocument()

Redeclares org.apache.poi.extractor.POITextExtractor.getDocument.

Return the underlying POIDocument

public default POITextExtractor

Returns:

an instance of POIExtractor that can extract meta-data.
getMetadataTextExtractor()

Implements org.apache.poi.extractor.POITextExtractor.getMetadataTextExtractor.

Returns an HPSF powered text extractor for the document properties metadata, such as title and author.

public default DirectoryEntry

Returns:

the DirectoryEntry that is associated with the POIDocument of this extractor.
getRoot()

Return the underlying DirectoryEntry of this document.

public default SummaryInformation

Returns:

The Summary information for the document or null if it could not be read for this document.
getSummaryInformation()

Returns the summary information metadata for the document.

Inherited from org.apache.poi.extractor.POITextExtractor:
closegetFilesystemgetTextisCloseFilesystemsetCloseFilesystem

Method Detail

getDocSummaryInformationback to summary
public default DocumentSummaryInformation getDocSummaryInformation()

Returns the document information metadata for the document

Returns:DocumentSummaryInformation

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

getDocumentback to summary
public POIDocument getDocument()

Redeclares org.apache.poi.extractor.POITextExtractor.getDocument.

Return the underlying POIDocument

Returns:POIDocument

the underlying POIDocument

Annotations
@Override
getMetadataTextExtractorback to summary
public default POITextExtractor getMetadataTextExtractor()

Implements org.apache.poi.extractor.POITextExtractor.getMetadataTextExtractor.

Returns an HPSF powered text extractor for the document properties metadata, such as title and author.

Returns:POITextExtractor

an instance of POIExtractor that can extract meta-data.

Annotations
@Override
getRootback to summary
public default DirectoryEntry getRoot()

Return the underlying DirectoryEntry of this document.

Returns:DirectoryEntry

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

getSummaryInformationback to summary
public default SummaryInformation getSummaryInformation()

Returns the summary information metadata for the document.

Returns:SummaryInformation

The Summary information for the document or null if it could not be read for this document.