Class AbstractOOXMLExtractor

java.lang.Object

org.apache.tika.parser.microsoft.ooxml.AbstractOOXMLExtractor

All Implemented Interfaces:

OOXMLExtractor

Direct Known Subclasses:

SXSLFPowerPointExtractorDecorator, SXWPFWordExtractorDecorator, VSDXExtractorDecorator, XPSExtractorDecorator, XSSFExcelExtractorDecorator

public abstract class AbstractOOXMLExtractor
extends Object
implements OOXMLExtractor

Base class for all Tika OOXML extractors.

Tika extractors decorate POI extractors so that the parsed content of documents is returned as a sequence of XHTML SAX events. Subclasses must implement the buildXHTML method buildXHTML(XHTMLContentHandler) that populates the XHTMLContentHandler object received as parameter.

Field Summary

Fields

Modifier and Type	Field	Description
protected OfficeParserConfig	config
protected static final String[]	EMBEDDED_RELATIONSHIPS
protected org.apache.poi.openxml4j.opc.OPCPackage	opcPackage

Constructor Summary

Constructors

Constructor	Description
AbstractOOXMLExtractor(ParseContext context, org.apache.poi.openxml4j.opc.OPCPackage opcPackage)

Method Summary

Modifier and Type	Method	Description
protected void	applyEmbeddedAnchorMetadata(org.apache.poi.openxml4j.opc.PackagePart part, Metadata metadata)	Hook for subclasses to apply anchor metadata (page or sheet numbers) to an embedded part's metadata, for paginated/sheeted containers.
protected abstract void	buildXHTML(XHTMLContentHandler xhtml)	Populates the XHTMLContentHandler object received as parameter.
protected Map<String, EmbeddedPartMetadata>	getEmbeddedPartMetadataMap()
protected String	getJustFileName(String desc)
protected abstract List<org.apache.poi.openxml4j.opc.PackagePart>	getMainDocumentParts()	Return a list of the main parts of the document, used when searching for embedded resources.
MetadataExtractor	getMetadataExtractor()
void	getXHTML(ContentHandler handler, Metadata metadata, ParseContext context)	Parses the document into a sequence of XHTML SAX events sent to the given content handler.
protected void	handleEmbeddedFile(org.apache.poi.openxml4j.opc.PackagePart part, XHTMLContentHandler xhtml, String rel, EmbeddedPartMetadata embeddedPartMetadata, TikaCoreProperties.EmbeddedResourceType embeddedResourceType)	Handles an embedded file in the document.
protected Map<String,String>	loadLinkedRelationships(org.apache.poi.openxml4j.opc.PackagePart bodyPart, boolean includeInternal, Metadata metadata)	This is used by the SAX docx and pptx decorators to load hyperlinks and other linked objects
static org.apache.poi.openxml4j.opc.PackagePart	safeGetRelatedPart(org.apache.poi.openxml4j.opc.PackagePart source, org.apache.poi.openxml4j.opc.PackageRelationship relationship)	Safely resolves a related part, returning null if the part cannot be found instead of throwing IllegalArgumentException.

Methods inherited from class Object

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

Field Details

EMBEDDED_RELATIONSHIPS

protected static final String[] EMBEDDED_RELATIONSHIPS

config

protected OfficeParserConfig config

opcPackage

protected org.apache.poi.openxml4j.opc.OPCPackage opcPackage

Constructor Details

AbstractOOXMLExtractor

public AbstractOOXMLExtractor(ParseContext context,
 org.apache.poi.openxml4j.opc.OPCPackage opcPackage)

Method Details

getMetadataExtractor

public MetadataExtractor getMetadataExtractor()

Specified by:

getMetadataExtractor in interface OOXMLExtractor

See Also:

• OOXMLExtractor.getMetadataExtractor()

getXHTML

public void getXHTML(ContentHandler handler,
 Metadata metadata,
 ParseContext context)
              throws SAXException,
IOException,
TikaException

Description copied from interface: OOXMLExtractor

Parses the document into a sequence of XHTML SAX events sent to the given content handler.

Specified by:

getXHTML in interface OOXMLExtractor

Throws:

SAXException

IOException

TikaException

See Also:

• OOXMLExtractor.getXHTML(ContentHandler, Metadata, ParseContext)

getEmbeddedPartMetadataMap

protected Map<String, EmbeddedPartMetadata> getEmbeddedPartMetadataMap()

applyEmbeddedAnchorMetadata

protected void applyEmbeddedAnchorMetadata(org.apache.poi.openxml4j.opc.PackagePart part,
 Metadata metadata)

Hook for subclasses to apply anchor metadata (page or sheet numbers) to an embedded part's metadata, for paginated/sheeted containers. Called from handleEmbeddedFile(PackagePart, XHTMLContentHandler, String, EmbeddedPartMetadata, TikaCoreProperties.EmbeddedResourceType) after the basic metadata (relationship id, content type, etc.) has been written, before the embedded part is handed off to the recursing parser.

Default is no-op — non-paginated containers (Word, Visio, ...) leave embedded resources without anchor metadata. Subclasses for paginated containers should override and invoke either PageAnchoring.applyPageMetadata(Metadata, Collection) (presentations) or PageAnchoring.applySheetMetadata(Metadata, Collection) (spreadsheets) with the indices for part. Letting each subclass own the write keeps the abstract class format-agnostic — pages vs. sheets is a per-format decision.

The PackagePart (not just its target URI) is supplied because relative target URIs differ depending on the relationship source (e.g. ../media/image1.png from a slide, or the same relative URI from an Excel drawing) and would not be stable lookup keys across sources. Subclasses can use part.getPartName().getName() for a canonical absolute path.

Parameters:

part - the embedded part being emitted

metadata - metadata to enrich

getJustFileName

protected String getJustFileName(String desc)

handleEmbeddedFile

protected void handleEmbeddedFile(org.apache.poi.openxml4j.opc.PackagePart part,
 XHTMLContentHandler xhtml,
 String rel,
 EmbeddedPartMetadata embeddedPartMetadata,
 TikaCoreProperties.EmbeddedResourceType embeddedResourceType)
                           throws SAXException,
IOException,
TikaException

Handles an embedded file in the document. Invokes applyEmbeddedAnchorMetadata(PackagePart, Metadata) so paginated/sheeted subclasses can tag the embedded resource's metadata with the pages or sheets it is anchored to.

Throws:

SAXException

IOException

TikaException

buildXHTML

protected abstract void buildXHTML(XHTMLContentHandler xhtml)
                            throws SAXException,
IOException

Populates the XHTMLContentHandler object received as parameter.

Throws:

SAXException

IOException

getMainDocumentParts

protected abstract List<org.apache.poi.openxml4j.opc.PackagePart> getMainDocumentParts()
                                                                                throws TikaException

Return a list of the main parts of the document, used when searching for embedded resources. This should be all the parts of the document that end up with things embedded into them.

Throws:

TikaException

loadLinkedRelationships

protected Map<String,String> loadLinkedRelationships(org.apache.poi.openxml4j.opc.PackagePart bodyPart,
 boolean includeInternal,
 Metadata metadata)

This is used by the SAX docx and pptx decorators to load hyperlinks and other linked objects

Parameters:

bodyPart -

Returns:

safeGetRelatedPart

public static org.apache.poi.openxml4j.opc.PackagePart safeGetRelatedPart(org.apache.poi.openxml4j.opc.PackagePart source,
 org.apache.poi.openxml4j.opc.PackageRelationship relationship)
                                                                   throws org.apache.poi.openxml4j.exceptions.InvalidFormatException

Safely resolves a related part, returning null if the part cannot be found instead of throwing IllegalArgumentException.

Throws:

org.apache.poi.openxml4j.exceptions.InvalidFormatException