Package org.apache.poi.hwpf.extractor

Class Word6Extractor

java.lang.Object

org.apache.poi.hwpf.extractor.Word6Extractor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, POIOLE2TextExtractor, POITextExtractor

public final class Word6Extractor
extends java.lang.Object
implements POIOLE2TextExtractor

Class to extract the text from old (Word 6 / Word 95) Word Documents. This should only be used on the older files, for most uses you should call WordExtractor which deals properly with HWPF.

Constructor Summary

Constructors

Constructor	Description
Word6Extractor(java.io.InputStream is)	Create a new Word Extractor
Word6Extractor(HWPFOldDocument doc)	Create a new Word Extractor
Word6Extractor(DirectoryNode dir)
Word6Extractor(DirectoryNode dir, POIFSFileSystem fs)	Deprecated. Use Word6Extractor(DirectoryNode) instead
Word6Extractor(POIFSFileSystem fs)	Create a new Word Extractor

Method Summary

Modifier and Type	Method	Description
HWPFOldDocument	getDocument()	Return the underlying POIDocument
HWPFOldDocument	getFilesystem()
java.lang.String[]	getParagraphText()	Deprecated.
java.lang.String	getText()	Retrieves all the text from the document.
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)

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 Detail

Word6Extractor

public Word6Extractor(java.io.InputStream is)
               throws java.io.IOException

Create a new Word Extractor

Parameters:

is - InputStream containing the word file

Throws:

java.io.IOException

Word6Extractor

public Word6Extractor(POIFSFileSystem fs)
               throws java.io.IOException

Create a new Word Extractor

Parameters:

fs - POIFSFileSystem containing the word file

Throws:

java.io.IOException

Word6Extractor

@Deprecated
public Word6Extractor(DirectoryNode dir,
                      POIFSFileSystem fs)
               throws java.io.IOException

Deprecated.

Use Word6Extractor(DirectoryNode) instead

Throws:

java.io.IOException

Word6Extractor

public Word6Extractor(DirectoryNode dir)
               throws java.io.IOException

Throws:

java.io.IOException

Word6Extractor

public Word6Extractor(HWPFOldDocument doc)

Create a new Word Extractor

Parameters:

doc - The HWPFOldDocument to extract from

Method Detail

getParagraphText

@Deprecated
public java.lang.String[] getParagraphText()

Deprecated.

Get the text from the word file, as an array with one String per paragraph

getText

public java.lang.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 HWPFOldDocument 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 HWPFOldDocument getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem