Package org.apache.poi.ooxml.extractor
Class POIXMLPropertiesTextExtractor
java.lang.Object
org.apache.poi.extractor.POITextExtractor
org.apache.poi.ooxml.extractor.POIXMLTextExtractor
org.apache.poi.ooxml.extractor.POIXMLPropertiesTextExtractor
- All Implemented Interfaces:
Closeable
,AutoCloseable
A
POITextExtractor
for returning the textual
content of the OOXML file properties, eg author
and title.-
Constructor Summary
ConstructorsConstructorDescriptionPOIXMLPropertiesTextExtractor
(POIXMLTextExtractor otherExtractor) Creates a new POIXMLPropertiesTextExtractor, for the same file that another TextExtractor is already working on.Creates a new POIXMLPropertiesTextExtractor for the given open document. -
Method Summary
Modifier and TypeMethodDescriptionReturns the core document properties, eg authorReturns the custom document properties, if there are anyReturns the extended document properties, eg applicationReturns an OOXML properties text extractor for the document properties metadata, such as title and author.getText()
Retrieves all the text from the document.Methods inherited from class org.apache.poi.ooxml.extractor.POIXMLTextExtractor
checkMaxTextSize, close, getCoreProperties, getCustomProperties, getDocument, getExtendedProperties, getPackage
Methods inherited from class org.apache.poi.extractor.POITextExtractor
setFilesystem
-
Constructor Details
-
POIXMLPropertiesTextExtractor
Creates a new POIXMLPropertiesTextExtractor for the given open document.- Parameters:
doc
- the given open document
-
POIXMLPropertiesTextExtractor
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
Returns the core document properties, eg author- Returns:
- the core document properties
-
getExtendedPropertiesText
Returns the extended document properties, eg application- Returns:
- the extended document properties
-
getCustomPropertiesText
Returns the custom document properties, if there are any- Returns:
- the custom document properties
-
getText
Description copied from class: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 classPOITextExtractor
- Returns:
- All the text from the document
-
getMetadataTextExtractor
Description copied from class:POIXMLTextExtractor
Returns an OOXML properties text extractor for the document properties metadata, such as title and author.- Overrides:
getMetadataTextExtractor
in classPOIXMLTextExtractor
- Returns:
- the metadata and text extractor
-