Package org.apache.tika.parser.microsoft.ooxml.xwpf

Class XWPFEventBasedWordExtractor

java.lang.Object

org.apache.tika.parser.microsoft.ooxml.xwpf.XWPFEventBasedWordExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, POITextExtractor, POIXMLTextExtractor

public class XWPFEventBasedWordExtractor
extends Object
implements POIXMLTextExtractor

Experimental class that is based on POI's XSSFEventBasedExcelExtractor

Constructor Summary

Constructors

Constructor	Description
XWPFEventBasedWordExtractor(OPCPackage container)

Method Summary

Modifier and Type	Method	Description
POIXMLProperties.CoreProperties	getCoreProperties()	Returns the core document properties
POIXMLProperties.CustomProperties	getCustomProperties()	Returns the custom document properties
POIXMLDocument	getDocument()	Returns opened document
POIXMLProperties.ExtendedProperties	getExtendedProperties()	Returns the extended document properties
Closeable	getFilesystem()
OPCPackage	getPackage()	Returns the opened OPCPackage that contains the document
String	getText()	Retrieves all the text from the document.
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean b)

Methods inherited from class java.lang.Object

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

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

checkMaxTextSize, close, getMetadataTextExtractor

Constructor Details

XWPFEventBasedWordExtractor

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

Throws:

XmlException

OpenXML4JException

IOException

Method Details

getPackage

public OPCPackage getPackage()

Description copied from interface: POIXMLTextExtractor

Returns the opened OPCPackage that contains the document

Specified by:

getPackage in interface POIXMLTextExtractor

Returns:

the opened OPCPackage

getCoreProperties

public POIXMLProperties.CoreProperties getCoreProperties()

Description copied from interface: POIXMLTextExtractor

Returns the core document properties

Specified by:

getCoreProperties in interface POIXMLTextExtractor

Returns:

the core document properties

getExtendedProperties

public POIXMLProperties.ExtendedProperties getExtendedProperties()

Description copied from interface: POIXMLTextExtractor

Returns the extended document properties

Specified by:

getExtendedProperties in interface POIXMLTextExtractor

Returns:

the extended document properties

getCustomProperties

public POIXMLProperties.CustomProperties getCustomProperties()

Description copied from interface: POIXMLTextExtractor

Returns the custom document properties

Specified by:

getCustomProperties in interface POIXMLTextExtractor

Returns:

the custom document properties

getDocument

public POIXMLDocument getDocument()

Description copied from interface: POIXMLTextExtractor

Returns opened document

Specified by:

getDocument in interface POITextExtractor

Specified by:

getDocument in interface POIXMLTextExtractor

Returns:

the opened document

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

setCloseFilesystem

public void setCloseFilesystem(boolean b)

Specified by:

setCloseFilesystem in interface POITextExtractor

Parameters:

b - 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 Closeable getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem