POIXMLPropertiesTextExtractor (POI API Documentation)

java.lang.Object
- org.apache.poi.POITextExtractor
- - org.apache.poi.POIXMLTextExtractor
  - - org.apache.poi.POIXMLPropertiesTextExtractor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class POIXMLPropertiesTextExtractor
extends POIXMLTextExtractor
```
A POITextExtractor for returning the textual content of the OOXML file properties, eg author and title.

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCorePropertiesText()` Returns the core document properties, eg author
`java.lang.String`	`getCustomPropertiesText()` Returns the custom document properties, if there are any
`java.lang.String`	`getExtendedPropertiesText()` Returns the extended document properties, eg application
`POIXMLPropertiesTextExtractor`	`getMetadataTextExtractor()` Returns an OOXML properties text extractor for the document properties metadata, such as title and author.
`java.lang.String`	`getText()`

Methods inherited from class org.apache.poi.POIXMLTextExtractor
checkMaxTextSize, close, getCoreProperties, getCustomProperties, getDocument, getExtendedProperties, getPackage

Methods inherited from class org.apache.poi.POITextExtractor
setFilesystem

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - 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 Detail
  - getCorePropertiesText
```
public java.lang.String getCorePropertiesText()
```
    Returns the core document properties, eg author
    
    Returns:
    the core document properties
  - getExtendedPropertiesText
```
public java.lang.String getExtendedPropertiesText()
```
    Returns the extended document properties, eg application
    
    Returns:
    the extended document properties
  - getCustomPropertiesText
```
public java.lang.String getCustomPropertiesText()
```
    Returns the custom document properties, if there are any
    
    Returns:
    the custom document properties
  - getText
```
public java.lang.String getText()
```
    Specified by:
    
    getText in class POITextExtractor
  - getMetadataTextExtractor
```
public POIXMLPropertiesTextExtractor 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 class POIXMLTextExtractor

Class POIXMLPropertiesTextExtractor

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.POIXMLTextExtractor

Methods inherited from class org.apache.poi.POITextExtractor

Methods inherited from class java.lang.Object

Constructor Detail

POIXMLPropertiesTextExtractor

POIXMLPropertiesTextExtractor

Method Detail

getCorePropertiesText

getExtendedPropertiesText

getCustomPropertiesText

getText

getMetadataTextExtractor