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

Interface OOXMLWordAndPowerPointTextHandler.XWPFBodyContentsHandler

All Known Implementing Classes:

OOXMLTikaBodyPartHandler

Enclosing class:

OOXMLWordAndPowerPointTextHandler

public static interface OOXMLWordAndPowerPointTextHandler.XWPFBodyContentsHandler

Method Summary

Modifier and Type	Method	Description
void	embeddedOLERef(String refId)
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()
default void	externalRef(String fieldType, String url)	Called when an external reference URL is found in a field code.
void	footnoteReference(String id)
void	hyperlinkEnd()
void	hyperlinkStart(String link)
boolean	isIncludeDeletedText()
boolean	isIncludeMoveFromText()
void	linkedOLERef(String refId)	Called when a linked (vs embedded) OLE object is found.
void	run(RunProperties runProperties, String contents)
void	startBookmark(String id, String name)
void	startEditedSection(String editor, Date date, OOXMLWordAndPowerPointTextHandler.EditType editType)
void	startParagraph(ParagraphProperties paragraphProperties)
void	startSDT()
void	startTable()
void	startTableCell()
void	startTableRow()

Method Detail

run

void run(RunProperties runProperties,
         String contents)
  throws SAXException

Throws:

SAXException

hyperlinkStart

void hyperlinkStart(String link)
             throws SAXException

Parameters:

link - the link; can be null

Throws:

SAXException

hyperlinkEnd

void hyperlinkEnd()
           throws SAXException

Throws:

SAXException

startParagraph

void startParagraph(ParagraphProperties paragraphProperties)
             throws SAXException

Throws:

SAXException

endParagraph

void endParagraph()
           throws SAXException

Throws:

SAXException

startTable

void startTable()
         throws SAXException

Throws:

SAXException

endTable

void endTable()
       throws SAXException

Throws:

SAXException

startTableRow

void startTableRow()
            throws SAXException

Throws:

SAXException

endTableRow

void endTableRow()
          throws SAXException

Throws:

SAXException

startTableCell

void startTableCell()
             throws SAXException

Throws:

SAXException

endTableCell

void endTableCell()
           throws SAXException

Throws:

SAXException

startSDT

void startSDT()
       throws SAXException

Throws:

SAXException

endSDT

void endSDT()
     throws SAXException

Throws:

SAXException

startEditedSection

void startEditedSection(String editor,
                        Date date,
                        OOXMLWordAndPowerPointTextHandler.EditType editType)
                 throws SAXException

Throws:

SAXException

endEditedSection

void endEditedSection()
               throws SAXException

Throws:

SAXException

isIncludeDeletedText

boolean isIncludeDeletedText()
                      throws SAXException

Throws:

SAXException

footnoteReference

void footnoteReference(String id)
                throws SAXException

Throws:

SAXException

endnoteReference

void endnoteReference(String id)
               throws SAXException

Throws:

SAXException

isIncludeMoveFromText

boolean isIncludeMoveFromText()
                       throws SAXException

Throws:

SAXException

embeddedOLERef

void embeddedOLERef(String refId)
             throws SAXException

Throws:

SAXException

linkedOLERef

void linkedOLERef(String refId)
           throws SAXException

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

Throws:

SAXException

embeddedPicRef

void embeddedPicRef(String picFileName,
                    String picDescription)
             throws SAXException

Throws:

SAXException

startBookmark

void startBookmark(String id,
                   String name)
            throws SAXException

Throws:

SAXException

endBookmark

void endBookmark(String id)
          throws SAXException

Throws:

SAXException

externalRef

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

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.

Parameters:

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

url - the external URL

Throws:

SAXException