Package org.apache.poi.hwpf.converter

Class WordToTextConverter

java.lang.Object

org.apache.poi.hwpf.converter.AbstractWordConverter

org.apache.poi.hwpf.converter.WordToTextConverter

@Beta
public class WordToTextConverter
extends AbstractWordConverter

Field Summary

Fields inherited from class org.apache.poi.hwpf.converter.AbstractWordConverter

UNICODECHAR_NO_BREAK_SPACE, UNICODECHAR_NONBREAKING_HYPHEN, UNICODECHAR_ZERO_WIDTH_SPACE

Constructor Summary

Constructors

Constructor	Description
WordToTextConverter()	Creates new instance of WordToTextConverter.
WordToTextConverter(TextDocumentFacade textDocumentFacade)
WordToTextConverter(Document document)	Creates new instance of WordToTextConverter.

Method Summary

Modifier and Type	Method	Description
protected void	afterProcess()	Special actions that need to be called after processing complete, like updating stylesheets or building document notes list.
Document	getDocument()
String	getText()
static String	getText(File docFile)
static String	getText(HWPFDocumentCore wordDocument)
static String	getText(DirectoryNode root)
boolean	isOutputSummaryInformation()
static void	main(String[] args)	Java main() interface to interact with WordToTextConverter
protected void	outputCharacters(Element block, CharacterRun characterRun, String text)
protected void	processBookmarks(HWPFDocumentCore wordDocument, Element currentBlock, Range range, int currentTableLevel, List<Bookmark> rangeBookmarks)	Wrap range into bookmark(s) and process it.
protected void	processDocumentInformation(SummaryInformation summaryInformation)
void	processDocumentPart(HWPFDocumentCore wordDocument, Range range)
protected void	processDrawnObject(HWPFDocument doc, CharacterRun characterRun, OfficeDrawing officeDrawing, String path, Element block)
protected void	processEndnoteAutonumbered(HWPFDocument wordDocument, int noteIndex, Element block, Range endnoteTextRange)
protected void	processFootnoteAutonumbered(HWPFDocument wordDocument, int noteIndex, Element block, Range footnoteTextRange)
protected void	processHyperlink(HWPFDocumentCore wordDocument, Element currentBlock, Range textRange, int currentTableLevel, String hyperlink)
protected void	processImage(Element currentBlock, boolean inlined, Picture picture)
protected void	processImage(Element currentBlock, boolean inlined, Picture picture, String url)
protected void	processImageWithoutPicturesManager(Element currentBlock, boolean inlined, Picture picture)
protected void	processLineBreak(Element block, CharacterRun characterRun)
protected boolean	processOle2(HWPFDocument wordDocument, Element block, Entry entry)
protected void	processPageBreak(HWPFDocumentCore wordDocument, Element flow)
protected void	processPageref(HWPFDocumentCore wordDocument, Element currentBlock, Range textRange, int currentTableLevel, String pageref)
protected void	processParagraph(HWPFDocumentCore wordDocument, Element parentElement, int currentTableLevel, Paragraph paragraph, String bulletText)
protected void	processSection(HWPFDocumentCore wordDocument, Section section, int s)
protected void	processTable(HWPFDocumentCore wordDocument, Element flow, Table table)
void	setOutputSummaryInformation(boolean outputDocumentInformation)

Methods inherited from class org.apache.poi.hwpf.converter.AbstractWordConverter

getCharacterRunTriplet, getFontReplacer, getNumberColumnsSpanned, getNumberRowsSpanned, getPicturesManager, processCharacters, processDeadField, processDocument, processDrawnObject, processDropDownList, processField, processNoteAnchor, processParagraphes, processSingleSection, processSymbol, setFontReplacer, setPicturesManager, tryDeadField

Methods inherited from class java.lang.Object

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

Constructor Detail

WordToTextConverter

public WordToTextConverter()
                    throws ParserConfigurationException

Creates new instance of WordToTextConverter. Can be used for output several HWPFDocuments into single text document.

Throws:

ParserConfigurationException - if an internal DocumentBuilder cannot be created

WordToTextConverter

public WordToTextConverter(Document document)

Creates new instance of WordToTextConverter. Can be used for output several HWPFDocuments into single text document.

Parameters:

document - XML DOM Document used as storage for text pieces

WordToTextConverter

public WordToTextConverter(TextDocumentFacade textDocumentFacade)

Method Detail

getText

public static String getText(DirectoryNode root)
                      throws Exception

Throws:

Exception

getText

public static String getText(File docFile)
                      throws Exception

Throws:

Exception

getText

public static String getText(HWPFDocumentCore wordDocument)
                      throws Exception

Throws:

Exception

main

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

Java main() interface to interact with WordToTextConverter

Usage: WordToTextConverter infile outfile

Where infile is an input .doc file ( Word 95-2007) which will be rendered as plain text into outfile

Throws:

Exception

afterProcess

protected void afterProcess()

Description copied from class: AbstractWordConverter

Special actions that need to be called after processing complete, like updating stylesheets or building document notes list. Usually they are called once, but it's okay to call them several times.

Overrides:

afterProcess in class AbstractWordConverter

getDocument

public Document getDocument()

Specified by:

getDocument in class AbstractWordConverter

getText

public String getText()
               throws Exception

Throws:

Exception

isOutputSummaryInformation

public boolean isOutputSummaryInformation()

outputCharacters

protected void outputCharacters(Element block,
                                CharacterRun characterRun,
                                String text)

Specified by:

outputCharacters in class AbstractWordConverter

processBookmarks

protected void processBookmarks(HWPFDocumentCore wordDocument,
                                Element currentBlock,
                                Range range,
                                int currentTableLevel,
                                List<Bookmark> rangeBookmarks)

Description copied from class: AbstractWordConverter

Wrap range into bookmark(s) and process it. All bookmarks have starts equal to range start and ends equal to range end. Usually it's only one bookmark.

Specified by:

processBookmarks in class AbstractWordConverter

processDocumentInformation

protected void processDocumentInformation(SummaryInformation summaryInformation)

Specified by:

processDocumentInformation in class AbstractWordConverter

processDocumentPart

public void processDocumentPart(HWPFDocumentCore wordDocument,
                                Range range)

Overrides:

processDocumentPart in class AbstractWordConverter

processDrawnObject

protected void processDrawnObject(HWPFDocument doc,
                                  CharacterRun characterRun,
                                  OfficeDrawing officeDrawing,
                                  String path,
                                  Element block)

Specified by:

processDrawnObject in class AbstractWordConverter

processEndnoteAutonumbered

protected void processEndnoteAutonumbered(HWPFDocument wordDocument,
                                          int noteIndex,
                                          Element block,
                                          Range endnoteTextRange)

Specified by:

processEndnoteAutonumbered in class AbstractWordConverter

processFootnoteAutonumbered

protected void processFootnoteAutonumbered(HWPFDocument wordDocument,
                                           int noteIndex,
                                           Element block,
                                           Range footnoteTextRange)

Specified by:

processFootnoteAutonumbered in class AbstractWordConverter

processHyperlink

protected void processHyperlink(HWPFDocumentCore wordDocument,
                                Element currentBlock,
                                Range textRange,
                                int currentTableLevel,
                                String hyperlink)

Specified by:

processHyperlink in class AbstractWordConverter

processImage

protected void processImage(Element currentBlock,
                            boolean inlined,
                            Picture picture)

Overrides:

processImage in class AbstractWordConverter

processImage

protected void processImage(Element currentBlock,
                            boolean inlined,
                            Picture picture,
                            String url)

Specified by:

processImage in class AbstractWordConverter

processImageWithoutPicturesManager

protected void processImageWithoutPicturesManager(Element currentBlock,
                                                  boolean inlined,
                                                  Picture picture)

Specified by:

processImageWithoutPicturesManager in class AbstractWordConverter

processLineBreak

protected void processLineBreak(Element block,
                                CharacterRun characterRun)

Specified by:

processLineBreak in class AbstractWordConverter

processOle2

protected boolean processOle2(HWPFDocument wordDocument,
                              Element block,
                              Entry entry)
                       throws Exception

Overrides:

processOle2 in class AbstractWordConverter

Throws:

Exception

processPageBreak

protected void processPageBreak(HWPFDocumentCore wordDocument,
                                Element flow)

Specified by:

processPageBreak in class AbstractWordConverter

processPageref

protected void processPageref(HWPFDocumentCore wordDocument,
                              Element currentBlock,
                              Range textRange,
                              int currentTableLevel,
                              String pageref)

Specified by:

processPageref in class AbstractWordConverter

processParagraph

protected void processParagraph(HWPFDocumentCore wordDocument,
                                Element parentElement,
                                int currentTableLevel,
                                Paragraph paragraph,
                                String bulletText)

Specified by:

processParagraph in class AbstractWordConverter

processSection

protected void processSection(HWPFDocumentCore wordDocument,
                              Section section,
                              int s)

Specified by:

processSection in class AbstractWordConverter

processTable

protected void processTable(HWPFDocumentCore wordDocument,
                            Element flow,
                            Table table)

Specified by:

processTable in class AbstractWordConverter

setOutputSummaryInformation

public void setOutputSummaryInformation(boolean outputDocumentInformation)