Class XWPFEventBasedWordExtractor
- java.lang.Object
-
- org.apache.tika.parser.microsoft.ooxml.xwpf.XWPFEventBasedWordExtractor
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,POITextExtractor
,POIXMLTextExtractor
public class XWPFEventBasedWordExtractor extends java.lang.Object implements POIXMLTextExtractor
Experimental class that is based on POI's XSSFEventBasedExcelExtractor
-
-
Constructor Summary
Constructors Constructor Description XWPFEventBasedWordExtractor(OPCPackage container)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description POIXMLProperties.CoreProperties
getCoreProperties()
Returns the core document propertiesPOIXMLProperties.CustomProperties
getCustomProperties()
Returns the custom document propertiesPOIXMLDocument
getDocument()
Returns opened documentPOIXMLProperties.ExtendedProperties
getExtendedProperties()
Returns the extended document propertiesjava.io.Closeable
getFilesystem()
OPCPackage
getPackage()
Returns the opened OPCPackage that contains the documentjava.lang.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 Detail
-
XWPFEventBasedWordExtractor
public XWPFEventBasedWordExtractor(OPCPackage container) throws XmlException, OpenXML4JException, java.io.IOException
- Throws:
XmlException
OpenXML4JException
java.io.IOException
-
-
Method Detail
-
getPackage
public OPCPackage getPackage()
Description copied from interface:POIXMLTextExtractor
Returns the opened OPCPackage that contains the document- Specified by:
getPackage
in interfacePOIXMLTextExtractor
- Returns:
- the opened OPCPackage
-
getCoreProperties
public POIXMLProperties.CoreProperties getCoreProperties()
Description copied from interface:POIXMLTextExtractor
Returns the core document properties- Specified by:
getCoreProperties
in interfacePOIXMLTextExtractor
- Returns:
- the core document properties
-
getExtendedProperties
public POIXMLProperties.ExtendedProperties getExtendedProperties()
Description copied from interface:POIXMLTextExtractor
Returns the extended document properties- Specified by:
getExtendedProperties
in interfacePOIXMLTextExtractor
- Returns:
- the extended document properties
-
getCustomProperties
public POIXMLProperties.CustomProperties getCustomProperties()
Description copied from interface:POIXMLTextExtractor
Returns the custom document properties- Specified by:
getCustomProperties
in interfacePOIXMLTextExtractor
- Returns:
- the custom document properties
-
getDocument
public POIXMLDocument getDocument()
Description copied from interface:POIXMLTextExtractor
Returns opened document- Specified by:
getDocument
in interfacePOITextExtractor
- Specified by:
getDocument
in interfacePOIXMLTextExtractor
- Returns:
- the opened document
-
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 interfacePOITextExtractor
- Returns:
- All the text from the document
-
setCloseFilesystem
public void setCloseFilesystem(boolean b)
- Specified by:
setCloseFilesystem
in interfacePOITextExtractor
- Parameters:
b
-true
(default), if underlying resources/filesystem should be closed onPOITextExtractor.close()
-
isCloseFilesystem
public boolean isCloseFilesystem()
- Specified by:
isCloseFilesystem
in interfacePOITextExtractor
- Returns:
true
, if resources/filesystem should be closed onPOITextExtractor.close()
-
getFilesystem
public java.io.Closeable getFilesystem()
- Specified by:
getFilesystem
in interfacePOITextExtractor
- Returns:
- The underlying resources/filesystem
-
-