Package org.apache.poi.hpbf.extractor

Class PublisherTextExtractor

java.lang.Object

org.apache.poi.hpbf.extractor.PublisherTextExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, POIOLE2TextExtractor, POITextExtractor

public final class PublisherTextExtractor
extends Object
implements POIOLE2TextExtractor

Extract text from HPBF Publisher files

Constructor Summary

Constructors

Constructor	Description
PublisherTextExtractor(InputStream is)
PublisherTextExtractor(HPBFDocument doc)
PublisherTextExtractor(DirectoryNode dir)
PublisherTextExtractor(POIFSFileSystem fs)

Method Summary

Modifier and Type	Method	Description
HPBFDocument	getDocument()	Return the underlying POIDocument
HPBFDocument	getFilesystem()
String	getText()	Retrieves all the text from the document.
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)
void	setHyperlinksByDefault(boolean hyperlinksByDefault)	Should a call to getText() return hyperlinks inline with the text? Default is no

Methods inherited from class java.lang.Object

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

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

getDocSummaryInformation, getMetadataTextExtractor, getRoot, getSummaryInformation

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

close

Constructor Details

PublisherTextExtractor

public PublisherTextExtractor(HPBFDocument doc)

PublisherTextExtractor

public PublisherTextExtractor(DirectoryNode dir)
                       throws IOException

Throws:

IOException

PublisherTextExtractor

public PublisherTextExtractor(POIFSFileSystem fs)
                       throws IOException

Throws:

IOException

PublisherTextExtractor

public PublisherTextExtractor(InputStream is)
                       throws IOException

Throws:

IOException

Method Details

setHyperlinksByDefault

public void setHyperlinksByDefault(boolean hyperlinksByDefault)

Should a call to getText() return hyperlinks inline with the text? Default is no

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

getDocument

public HPBFDocument getDocument()

Description copied from interface: POIOLE2TextExtractor

Return the underlying POIDocument

Specified by:

getDocument in interface POIOLE2TextExtractor

Specified by:

getDocument in interface POITextExtractor

Returns:

the underlying POIDocument

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 HPBFDocument getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem