org.apache.poi.hpsf.extractor

Class HPSFPropertiesExtractor

java.lang.Object

org.apache.poi.extractor.POITextExtractor

org.apache.poi.extractor.POIOLE2TextExtractor

org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor

All Implemented Interfaces:

Closeable, AutoCloseable

public class HPSFPropertiesExtractor
extends POIOLE2TextExtractor

Extracts all of the HPSF properties, both build in and custom, returning them in textual form.

Constructor Summary

Constructors

Constructor and Description
HPSFPropertiesExtractor(POIDocument doc)
HPSFPropertiesExtractor(POIFSFileSystem fs)
HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDocumentSummaryInformationText()
POITextExtractor	getMetadataTextExtractor() Prevent recursion!
String	getSummaryInformationText()
String	getText() Retrieves all the text from the document.
int	hashCode()
static void	main(String[] args)

Methods inherited from class org.apache.poi.extractor.POIOLE2TextExtractor

getDocSummaryInformation, getDocument, getRoot, getSummaryInformation

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

close, setFilesystem

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIDocument doc)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIFSFileSystem fs)

Method Detail

getDocumentSummaryInformationText

public String getDocumentSummaryInformationText()

getSummaryInformationText

public String getSummaryInformationText()

getText

public String 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 class POITextExtractor

Returns:

the text of all the properties defined in the document.

getMetadataTextExtractor

public POITextExtractor getMetadataTextExtractor()

Prevent recursion!

Overrides:

getMetadataTextExtractor in class POIOLE2TextExtractor

Returns:

an instance of POIExtractor that can extract meta-data.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException