org.apache.poi.ooxml.extractor

Interface POIXMLTextExtractor

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, POITextExtractor

All Known Implementing Classes:

POIXMLPropertiesTextExtractor, XDGFVisioExtractor, XSLFExtractor, XSSFBEventBasedExcelExtractor, XSSFEventBasedExcelExtractor, XSSFExcelExtractor, XWPFWordExtractor

public interface POIXMLTextExtractor
extends POITextExtractor

Method Summary

Modifier and Type	Method and Description
default void	checkMaxTextSize(java.lang.CharSequence text, java.lang.String string)
default void	close() Allows to free resources of the Extractor as soon as it is not needed any more.
default POIXMLProperties.CoreProperties	getCoreProperties() Returns the core document properties
default POIXMLProperties.CustomProperties	getCustomProperties() Returns the custom document properties
POIXMLDocument	getDocument() Returns opened document
default POIXMLProperties.ExtendedProperties	getExtendedProperties() Returns the extended document properties
default POIXMLPropertiesTextExtractor	getMetadataTextExtractor() Returns an OOXML properties text extractor for the document properties metadata, such as title and author.
default OPCPackage	getPackage() Returns the opened OPCPackage that contains the document

Methods inherited from interface org.apache.poi.extractor.POITextExtractor

getFilesystem, getText, isCloseFilesystem, setCloseFilesystem

Method Detail

getCoreProperties

default POIXMLProperties.CoreProperties getCoreProperties()

Returns the core document properties

Returns:

the core document properties

getExtendedProperties

default POIXMLProperties.ExtendedProperties getExtendedProperties()

Returns the extended document properties

Returns:

the extended document properties

getCustomProperties

default POIXMLProperties.CustomProperties getCustomProperties()

Returns the custom document properties

Returns:

the custom document properties

getDocument

POIXMLDocument getDocument()

Returns opened document

Specified by:

getDocument in interface POITextExtractor

Returns:

the opened document

getPackage

default OPCPackage getPackage()

Returns the opened OPCPackage that contains the document

Returns:

the opened OPCPackage

getMetadataTextExtractor

default POIXMLPropertiesTextExtractor getMetadataTextExtractor()

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

Specified by:

getMetadataTextExtractor in interface POITextExtractor

Returns:

the metadata and text extractor

close

default void close()
            throws java.io.IOException

Description copied from interface: POITextExtractor

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

Specified by:

close in interface POITextExtractor

Throws:

java.io.IOException

checkMaxTextSize

default void checkMaxTextSize(java.lang.CharSequence text,
                              java.lang.String string)