org.apache.poi.hpsf.extractor
Class HPSFPropertiesExtractor

java.lang.Object
  extended by org.apache.poi.POITextExtractor
      extended by org.apache.poi.POIOLE2TextExtractor
          extended by org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor
All Implemented Interfaces:
java.io.Closeable

public class HPSFPropertiesExtractor
extends POIOLE2TextExtractor

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


Field Summary
 
Fields inherited from class org.apache.poi.POIOLE2TextExtractor
document
 
Constructor Summary
HPSFPropertiesExtractor(NPOIFSFileSystem fs)
           
HPSFPropertiesExtractor(POIDocument doc)
           
HPSFPropertiesExtractor(POIFSFileSystem fs)
           
HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)
           
 
Method Summary
 void close()
          Allows to free resources of the Extractor as soon as it is not needed any more.
 java.lang.String getDocumentSummaryInformationText()
           
 POITextExtractor getMetadataTextExtractor()
          Prevent recursion!
 java.lang.String getSummaryInformationText()
           
 java.lang.String getText()
          Retrieves all the text from the document.
static void main(java.lang.String[] args)
           
 
Methods inherited from class org.apache.poi.POIOLE2TextExtractor
getDocSummaryInformation, getRoot, getSummaryInformation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIDocument doc)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIFSFileSystem fs)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(NPOIFSFileSystem fs)
Method Detail

getDocumentSummaryInformationText

public java.lang.String getDocumentSummaryInformationText()

getSummaryInformationText

public java.lang.String getSummaryInformationText()

getText

public java.lang.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.

close

public void close()
           throws java.io.IOException
Description copied from class: 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.io.Closeable
Overrides:
close in class POITextExtractor
Throws:
java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException
Throws:
java.io.IOException


Copyright 2015 The Apache Software Foundation or its licensors, as applicable.