org.apache.poi.extractor

Class POITextExtractor

java.lang.Object

org.apache.poi.extractor.POITextExtractor

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

POIOLE2TextExtractor, org.apache.poi.ooxml.extractor.POIXMLTextExtractor

public abstract class POITextExtractor
extends Object
implements 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, PowerPointExtractor, VisioTextExtractor, WordExtractor

Constructor Summary

Constructors

Constructor and Description
POITextExtractor()

Method Summary

Modifier and Type	Method and Description
void	close() Allows to free resources of the Extractor as soon as it is not needed any more.
abstract Object	getDocument()
abstract POITextExtractor	getMetadataTextExtractor() Returns another text extractor, which is able to output the textual content of the document metadata / properties, such as author and title.
abstract String	getText() Retrieves all the text from the document.
void	setFilesystem(Closeable fs) Used to ensure file handle cleanup.

Methods inherited from class java.lang.Object

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

Constructor Detail

POITextExtractor

public POITextExtractor()

Method Detail

getText

public abstract 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

public abstract 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

setFilesystem

public void setFilesystem(Closeable fs)

Used to ensure file handle cleanup.

Parameters:

fs - filesystem to close

close

public void close()
           throws 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 Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getDocument

public abstract Object getDocument()

Returns:

the processed document