Package org.apache.poi.xwpf.extractor

Class XWPFWordExtractor

java.lang.Object

org.apache.poi.extractor.POITextExtractor

org.apache.poi.ooxml.extractor.POIXMLTextExtractor

org.apache.poi.xwpf.extractor.XWPFWordExtractor

All Implemented Interfaces:

Closeable, AutoCloseable

public class XWPFWordExtractor
extends org.apache.poi.ooxml.extractor.POIXMLTextExtractor

Helper class to extract text from an OOXML Word file

Field Summary

Fields

Modifier and Type	Field	Description
static XWPFRelation[]	SUPPORTED_TYPES

Constructor Summary

Constructors

Constructor	Description
XWPFWordExtractor(OPCPackage container)
XWPFWordExtractor(XWPFDocument document)

Method Summary

Modifier and Type	Method	Description
void	appendBodyElementText(StringBuilder text, IBodyElement e)
void	appendParagraphText(StringBuilder text, XWPFParagraph paragraph)
String	getText()	Retrieves all the text from the document.
static void	main(String[] args)
void	setConcatenatePhoneticRuns(boolean concatenatePhoneticRuns)	Should we concatenate phonetic runs in extraction.
void	setFetchHyperlinks(boolean fetch)	Should we also fetch the hyperlinks, when fetching the text content? Default is to only output the hyperlink label, and not the contents

Methods inherited from class org.apache.poi.ooxml.extractor.POIXMLTextExtractor

close, getCoreProperties, getCustomProperties, getDocument, getExtendedProperties, getMetadataTextExtractor, getPackage

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

setFilesystem

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_TYPES

public static final XWPFRelation[] SUPPORTED_TYPES

Constructor Detail

XWPFWordExtractor

public XWPFWordExtractor(OPCPackage container)
                  throws XmlException,
                         OpenXML4JException,
                         IOException

Throws:

XmlException

OpenXML4JException

IOException

XWPFWordExtractor

public XWPFWordExtractor(XWPFDocument document)

Method Detail

main

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

Throws:

Exception

setFetchHyperlinks

public void setFetchHyperlinks(boolean fetch)

Should we also fetch the hyperlinks, when fetching the text content? Default is to only output the hyperlink label, and not the contents

setConcatenatePhoneticRuns

public void setConcatenatePhoneticRuns(boolean concatenatePhoneticRuns)

Should we concatenate phonetic runs in extraction. Default is true

Parameters:

concatenatePhoneticRuns -

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:

All the text from the document

appendBodyElementText

public void appendBodyElementText(StringBuilder text,
                                  IBodyElement e)

appendParagraphText

public void appendParagraphText(StringBuilder text,
                                XWPFParagraph paragraph)