org.apache.poi.extractor

Interface POITextExtractor

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

POIOLE2TextExtractor, POIXMLTextExtractor

All Known Implementing Classes:

EventBasedExcelExtractor, ExcelExtractor, HPSFPropertiesExtractor, OldExcelExtractor, OutlookTextExtractor, POIXMLPropertiesTextExtractor, PublisherTextExtractor, SlideShowExtractor, VisioTextExtractor, Word6Extractor, WordExtractor, XDGFVisioExtractor, XSLFExtractor, XSSFBEventBasedExcelExtractor, XSSFEventBasedExcelExtractor, XSSFExcelExtractor, XWPFWordExtractor

public interface POITextExtractor
extends java.io.Closeable

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

See Also:

ExcelExtractor, VisioTextExtractor, WordExtractor

Method Summary

Modifier and Type	Method and Description
default void	close() Allows to free resources of the Extractor as soon as it is not needed any more.
java.lang.Object	getDocument()
java.io.Closeable	getFilesystem()
POITextExtractor	getMetadataTextExtractor() Returns another text extractor, which is able to output the textual content of the document metadata / properties, such as author and title.
java.lang.String	getText() Retrieves all the text from the document.
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)

Method Detail

getText

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

getMetadataTextExtractor

POITextExtractor getMetadataTextExtractor()

Returns another text extractor, which is able to output the textual content of the document metadata / properties, such as author and title.

Returns:

the metadata and text extractor

setCloseFilesystem

void setCloseFilesystem(boolean doCloseFilesystem)

Parameters:

doCloseFilesystem - true (default), if underlying resources/filesystem should be closed on close()

isCloseFilesystem

boolean isCloseFilesystem()

Returns:

true, if resources/filesystem should be closed on close()

getFilesystem

java.io.Closeable getFilesystem()

Returns:

The underlying resources/filesystem

close

default void close()
            throws java.io.IOException

Allows to free resources of the Extractor as soon as it is not needed any more. This may include closing open file handles and freeing memory. The Extractor cannot be used after close has been called.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

getDocument

java.lang.Object getDocument()

Returns:

the processed document