Package org.apache.poi.ooxml.extractor

Class POIXMLPropertiesTextExtractor

java.lang.Object

org.apache.poi.ooxml.extractor.POIXMLPropertiesTextExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, POITextExtractor, POIXMLTextExtractor

public class POIXMLPropertiesTextExtractor
extends Object
implements POIXMLTextExtractor

A POITextExtractor for returning the textual content of the OOXML file properties, eg author and title.

Constructor Summary

Constructors

Constructor	Description
POIXMLPropertiesTextExtractor(POIXMLTextExtractor otherExtractor)	Creates a new POIXMLPropertiesTextExtractor, for the same file that another TextExtractor is already working on.
POIXMLPropertiesTextExtractor(POIXMLDocument doc)	Creates a new POIXMLPropertiesTextExtractor for the given open document.

Method Summary

Modifier and Type	Method	Description
String	getCorePropertiesText()	Returns the core document properties, eg author
String	getCustomPropertiesText()	Returns the custom document properties, if there are any
POIXMLDocument	getDocument()	Returns opened document
String	getExtendedPropertiesText()	Returns the extended document properties, eg application
POIXMLDocument	getFilesystem()
POIXMLPropertiesTextExtractor	getMetadataTextExtractor()	Returns an OOXML properties text extractor for the document properties metadata, such as title and author.
String	getText()	Retrieves all the text from the document.
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.ooxml.extractor.POIXMLTextExtractor

checkMaxTextSize, close, getCoreProperties, getCustomProperties, getExtendedProperties, getPackage

Constructor Details

POIXMLPropertiesTextExtractor

public POIXMLPropertiesTextExtractor(POIXMLDocument doc)

Creates a new POIXMLPropertiesTextExtractor for the given open document.

Parameters:

doc - the given open document

POIXMLPropertiesTextExtractor

public POIXMLPropertiesTextExtractor(POIXMLTextExtractor otherExtractor)

Creates a new POIXMLPropertiesTextExtractor, for the same file that another TextExtractor is already working on.

Parameters:

otherExtractor - the extractor referencing the given file

Method Details

getCorePropertiesText

public String getCorePropertiesText()

Returns the core document properties, eg author

Returns:

the core document properties

getExtendedPropertiesText

public String getExtendedPropertiesText()

Returns the extended document properties, eg application

Returns:

the extended document properties

getCustomPropertiesText

public String getCustomPropertiesText()

Returns the custom document properties, if there are any

Returns:

the custom document properties

getText

public String getText()

Description copied from interface: POITextExtractor

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.

Specified by:

getText in interface POITextExtractor

Returns:

All the text from the document

getMetadataTextExtractor

public POIXMLPropertiesTextExtractor getMetadataTextExtractor()

Description copied from interface: POIXMLTextExtractor

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

Specified by:

getMetadataTextExtractor in interface POITextExtractor

Specified by:

getMetadataTextExtractor in interface POIXMLTextExtractor

Returns:

the metadata and text extractor

getDocument

public POIXMLDocument getDocument()

Description copied from interface: POIXMLTextExtractor

Returns opened document

Specified by:

getDocument in interface POITextExtractor

Specified by:

getDocument in interface POIXMLTextExtractor

Returns:

the opened document

setCloseFilesystem

public void setCloseFilesystem(boolean doCloseFilesystem)

Specified by:

setCloseFilesystem in interface POITextExtractor

Parameters:

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

isCloseFilesystem

public boolean isCloseFilesystem()

Specified by:

isCloseFilesystem in interface POITextExtractor

Returns:

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

getFilesystem

public POIXMLDocument getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem