XWPFWordExtractor (POI API Documentation)

java.lang.Object
- org.apache.poi.POITextExtractor
- - org.apache.poi.POIXMLTextExtractor
  - - org.apache.poi.xwpf.extractor.XWPFWordExtractor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class XWPFWordExtractor
extends POIXMLTextExtractor
```
Helper class to extract text from an OOXML Word file

Field Summary

Fields
Modifier and Type Field and Description

static XWPFRelation[] SUPPORTED_TYPES

Fields
Modifier and Type	Field and Description
`static XWPFRelation[]`	`SUPPORTED_TYPES`

Constructor Summary

Constructors
Constructor and Description

XWPFWordExtractor(OPCPackage container)

XWPFWordExtractor(XWPFDocument document)

Constructors
Constructor and Description
`XWPFWordExtractor(OPCPackage container)`
`XWPFWordExtractor(XWPFDocument document)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendBodyElementText(java.lang.StringBuffer text, IBodyElement e)`
`void`	`appendParagraphText(java.lang.StringBuffer text, XWPFParagraph paragraph)`
`java.lang.String`	`getText()`
`static void`	`main(java.lang.String[] args)`
`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.POIXMLTextExtractor
checkMaxTextSize, close, getCoreProperties, getCustomProperties, getDocument, getExtendedProperties, getMetadataTextExtractor, getPackage

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

Methods inherited from class java.lang.Object
clone, equals, finalize, 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 org.apache.xmlbeans.XmlException,
                         OpenXML4JException,
                         java.io.IOException

Throws:: org.apache.xmlbeans.XmlException; OpenXML4JException; java.io.IOException

XWPFWordExtractor

public XWPFWordExtractor(XWPFDocument document)

Method Detail

main

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

Throws:: java.lang.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

getText
```
public java.lang.String getText()
```
Specified by:

getText in class POITextExtractor

appendBodyElementText

public void appendBodyElementText(java.lang.StringBuffer text,
                         IBodyElement e)

appendParagraphText

public void appendParagraphText(java.lang.StringBuffer text,
                       XWPFParagraph paragraph)

Class XWPFWordExtractor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.POIXMLTextExtractor

Methods inherited from class org.apache.poi.POITextExtractor

Methods inherited from class java.lang.Object

Field Detail

SUPPORTED_TYPES

Constructor Detail

XWPFWordExtractor

XWPFWordExtractor

Method Detail

main

setFetchHyperlinks

getText

appendBodyElementText

appendParagraphText