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

Class OOXMLTikaBodyPartHandler

java.lang.Object

org.apache.tika.parser.microsoft.ooxml.OOXMLTikaBodyPartHandler

All Implemented Interfaces:

XWPFBodyContentsHandler

public class OOXMLTikaBodyPartHandler
extends Object
implements XWPFBodyContentsHandler

Constructor Summary

Constructors

Constructor	Description
OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml)
OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml, Metadata metadata)
OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml, XWPFStylesShim styles, XWPFListManager listManager, OfficeParserConfig parserConfig)
OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml, XWPFStylesShim styles, XWPFListManager listManager, OfficeParserConfig parserConfig, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
void	commentReference(String id)	Called when a comment reference is encountered in the document body.
void	embeddedOLERef(String relId, String progId, String emfImageRId)
void	embeddedPicRef(String picFileName, String picDescription)
void	endBookmark(String id)
void	endEditedSection()
void	endnoteReference(String id)
void	endParagraph()
void	endSDT()
void	endTable()
void	endTableCell()
void	endTableRow()
void	externalRef(String fieldType, String url)	Called when an external reference URL is found in a field code.
void	fieldCodeHyperlinkStart(String link)	Called when a hyperlink is found via a field code (instrText HYPERLINK).
void	footnoteReference(String id)
Map<String,EmbeddedPartMetadata>	getEmbeddedPartMetadataMap()
Set<String>	getEmittedCommentIds()	Returns the set of comment IDs that were inlined during parsing.
void	hyperlinkEnd()
void	hyperlinkStart(String link)
boolean	isIncludeDeletedText()
boolean	isIncludeMoveFromText()
void	linkedOLERef(String relId)	Called when a linked (vs embedded) OLE object is found.
void	run(RunProperties runProperties, String contents)
void	setInlineBodyPartMap(org.apache.tika.parser.microsoft.ooxml.OOXMLInlineBodyPartMap inlinePartMap, ParseContext parseContext)	Sets pre-parsed inline body part content (footnotes, endnotes, comments) so that references encountered during main document parsing can be resolved inline.
void	startBookmark(String id, String name)
void	startEditedSection(String editor, Date date, EditType editType)
void	startParagraph(ParagraphProperties paragraphProperties)
void	startSDT()
void	startTable()
void	startTableCell()
void	startTableRow()

Methods inherited from class java.lang.Object

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

Constructor Details

OOXMLTikaBodyPartHandler

public OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml)

OOXMLTikaBodyPartHandler

public OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml,
 Metadata metadata)

OOXMLTikaBodyPartHandler

public OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml,
 XWPFStylesShim styles,
 XWPFListManager listManager,
 OfficeParserConfig parserConfig)

OOXMLTikaBodyPartHandler

public OOXMLTikaBodyPartHandler(XHTMLContentHandler xhtml,
 XWPFStylesShim styles,
 XWPFListManager listManager,
 OfficeParserConfig parserConfig,
 Metadata metadata)

Method Details

setInlineBodyPartMap

public void setInlineBodyPartMap(org.apache.tika.parser.microsoft.ooxml.OOXMLInlineBodyPartMap inlinePartMap,
 ParseContext parseContext)

Sets pre-parsed inline body part content (footnotes, endnotes, comments) so that references encountered during main document parsing can be resolved inline.

run

public void run(RunProperties runProperties,
 String contents)
         throws SAXException

Specified by:

run in interface XWPFBodyContentsHandler

Throws:

SAXException

hyperlinkStart

public void hyperlinkStart(String link)
                    throws SAXException

Specified by:

hyperlinkStart in interface XWPFBodyContentsHandler

Parameters:

link - the link; can be null

Throws:

SAXException

hyperlinkEnd

public void hyperlinkEnd()
                  throws SAXException

Specified by:

hyperlinkEnd in interface XWPFBodyContentsHandler

Throws:

SAXException

startParagraph

public void startParagraph(ParagraphProperties paragraphProperties)
                    throws SAXException

Specified by:

startParagraph in interface XWPFBodyContentsHandler

Throws:

SAXException

endParagraph

public void endParagraph()
                  throws SAXException

Specified by:

endParagraph in interface XWPFBodyContentsHandler

Throws:

SAXException

getEmittedCommentIds

public Set<String> getEmittedCommentIds()

Returns the set of comment IDs that were inlined during parsing. Used by the decorator to skip these when dumping remaining comments.

startTable

public void startTable()
                throws SAXException

Specified by:

startTable in interface XWPFBodyContentsHandler

Throws:

SAXException

endTable

public void endTable()
              throws SAXException

Specified by:

endTable in interface XWPFBodyContentsHandler

Throws:

SAXException

startTableRow

public void startTableRow()
                   throws SAXException

Specified by:

startTableRow in interface XWPFBodyContentsHandler

Throws:

SAXException

endTableRow

public void endTableRow()
                 throws SAXException

Specified by:

endTableRow in interface XWPFBodyContentsHandler

Throws:

SAXException

startTableCell

public void startTableCell()
                    throws SAXException

Specified by:

startTableCell in interface XWPFBodyContentsHandler

Throws:

SAXException

endTableCell

public void endTableCell()
                  throws SAXException

Specified by:

endTableCell in interface XWPFBodyContentsHandler

Throws:

SAXException

startSDT

public void startSDT()
              throws SAXException

Specified by:

startSDT in interface XWPFBodyContentsHandler

Throws:

SAXException

endSDT

public void endSDT()

Specified by:

endSDT in interface XWPFBodyContentsHandler

startEditedSection

public void startEditedSection(String editor,
 Date date,
 EditType editType)

Specified by:

startEditedSection in interface XWPFBodyContentsHandler

endEditedSection

public void endEditedSection()

Specified by:

endEditedSection in interface XWPFBodyContentsHandler

isIncludeDeletedText

public boolean isIncludeDeletedText()

Specified by:

isIncludeDeletedText in interface XWPFBodyContentsHandler

footnoteReference

public void footnoteReference(String id)
                       throws SAXException

Specified by:

footnoteReference in interface XWPFBodyContentsHandler

Throws:

SAXException

endnoteReference

public void endnoteReference(String id)
                      throws SAXException

Specified by:

endnoteReference in interface XWPFBodyContentsHandler

Throws:

SAXException

commentReference

public void commentReference(String id)
                      throws SAXException

Description copied from interface: XWPFBodyContentsHandler

Called when a comment reference is encountered in the document body.

Specified by:

commentReference in interface XWPFBodyContentsHandler

Parameters:

id - the comment ID

Throws:

SAXException

isIncludeMoveFromText

public boolean isIncludeMoveFromText()

Specified by:

isIncludeMoveFromText in interface XWPFBodyContentsHandler

embeddedOLERef

public void embeddedOLERef(String relId,
 String progId,
 String emfImageRId)
                    throws SAXException

Specified by:

embeddedOLERef in interface XWPFBodyContentsHandler

Throws:

SAXException

getEmbeddedPartMetadataMap

public Map<String,EmbeddedPartMetadata> getEmbeddedPartMetadataMap()

linkedOLERef

public void linkedOLERef(String relId)
                  throws SAXException

Description copied from interface: XWPFBodyContentsHandler

Called when a linked (vs embedded) OLE object is found. These reference external files and are a security concern.

Specified by:

linkedOLERef in interface XWPFBodyContentsHandler

Throws:

SAXException

embeddedPicRef

public void embeddedPicRef(String picFileName,
 String picDescription)
                    throws SAXException

Specified by:

embeddedPicRef in interface XWPFBodyContentsHandler

Throws:

SAXException

fieldCodeHyperlinkStart

public void fieldCodeHyperlinkStart(String link)
                             throws SAXException

Description copied from interface: XWPFBodyContentsHandler

Called when a hyperlink is found via a field code (instrText HYPERLINK). Distinct from relationship-based hyperlinks for security tracking purposes.

Specified by:

fieldCodeHyperlinkStart in interface XWPFBodyContentsHandler

Parameters:

link - the link URL

Throws:

SAXException

externalRef

public void externalRef(String fieldType,
 String url)
                 throws SAXException

Description copied from interface: XWPFBodyContentsHandler

Called when an external reference URL is found in a field code. This includes INCLUDEPICTURE, INCLUDETEXT, IMPORT, LINK fields, and DrawingML/VML hyperlinks on shapes.

Specified by:

externalRef in interface XWPFBodyContentsHandler

Parameters:

fieldType - the type of field (e.g., "INCLUDEPICTURE", "hlinkHover", "vml-href")

url - the external URL

Throws:

SAXException

startBookmark

public void startBookmark(String id,
 String name)
                   throws SAXException

Specified by:

startBookmark in interface XWPFBodyContentsHandler

Throws:

SAXException

endBookmark

public void endBookmark(String id)

Specified by:

endBookmark in interface XWPFBodyContentsHandler