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

Class XSSFExcelExtractorDecorator

java.lang.Object

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

org.apache.tika.parser.microsoft.ooxml.XSSFExcelExtractorDecorator

All Implemented Interfaces:

OOXMLExtractor

Direct Known Subclasses:

XSSFBExcelExtractorDecorator

public class XSSFExcelExtractorDecorator
extends AbstractOOXMLExtractor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	XSSFExcelExtractorDecorator.HeaderFooterFromString
protected static class	XSSFExcelExtractorDecorator.SheetTextAsHTML	Turns formatted sheet events into HTML
protected static class	XSSFExcelExtractorDecorator.XSSFSheetInterestingPartsCapturer	Captures information on interesting tags, whilst delegating the main work to the formatting handler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,String>	drawingHyperlinks
protected final org.apache.poi.ss.usermodel.DataFormatter	formatter
protected static org.apache.poi.xssf.usermodel.helpers.HeaderFooterHelper	hfHelper	Allows access to headers/footers from raw xml strings
protected Metadata	metadata
protected ParseContext	parseContext
protected final List<org.apache.poi.openxml4j.opc.PackagePart>	sheetParts

Fields inherited from class org.apache.tika.parser.microsoft.ooxml.AbstractOOXMLExtractor

config, EMBEDDED_RELATIONSHIPS, opcPackage

Constructor Summary

Constructors

Constructor	Description
XSSFExcelExtractorDecorator(ParseContext context, org.apache.poi.openxml4j.opc.OPCPackage pkg, Locale locale)

Method Summary

Modifier and Type	Method	Description
protected void	addDrawingHyperLinks(org.apache.poi.openxml4j.opc.PackagePart sheetPart)
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 void	buildXHTML(XHTMLContentHandler xhtml)	Populates the XHTMLContentHandler object received as parameter.
protected void	extractHeaderFooter(String hf, XHTMLContentHandler xhtml)
protected void	extractHyperLinks(org.apache.poi.openxml4j.opc.PackagePart sheetPart, XHTMLContentHandler xhtml)
protected List<org.apache.poi.openxml4j.opc.PackagePart>	getMainDocumentParts()	In Excel files, sheets have things embedded in them, and sheet drawings which have the images
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	processDrawings(org.apache.poi.openxml4j.opc.PackagePart sheetPart, XHTMLContentHandler xhtml)
void	processSheet(org.apache.tika.parser.microsoft.ooxml.TikaSheetContentsHandler sheetContentsHandler, org.apache.tika.parser.microsoft.ooxml.XSSFCommentsShim commentsShim, org.apache.tika.parser.microsoft.ooxml.XSSFStylesShim stylesShim, org.apache.tika.parser.microsoft.ooxml.XSSFSharedStringsShim stringsShim, InputStream sheetInputStream)

Methods inherited from class org.apache.tika.parser.microsoft.ooxml.AbstractOOXMLExtractor

getEmbeddedPartMetadataMap, getJustFileName, handleEmbeddedFile, loadLinkedRelationships, safeGetRelatedPart

Methods inherited from class java.lang.Object

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

Field Details

hfHelper

protected static org.apache.poi.xssf.usermodel.helpers.HeaderFooterHelper hfHelper

Allows access to headers/footers from raw xml strings

formatter

protected final org.apache.poi.ss.usermodel.DataFormatter formatter

sheetParts

protected final List<org.apache.poi.openxml4j.opc.PackagePart> sheetParts

drawingHyperlinks

protected final Map<String,String> drawingHyperlinks

metadata

protected Metadata metadata

parseContext

protected ParseContext parseContext

Constructor Details

XSSFExcelExtractorDecorator

public XSSFExcelExtractorDecorator(ParseContext context,
 org.apache.poi.openxml4j.opc.OPCPackage pkg,
 Locale locale)

Method Details

getMetadataExtractor

public MetadataExtractor getMetadataExtractor()

Specified by:

getMetadataExtractor in interface OOXMLExtractor

Overrides:

getMetadataExtractor in class AbstractOOXMLExtractor

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

Overrides:

getXHTML in class AbstractOOXMLExtractor

Throws:

SAXException

IOException

TikaException

See Also:

• OOXMLExtractor.getXHTML(ContentHandler, Metadata, ParseContext)

buildXHTML

protected void buildXHTML(XHTMLContentHandler xhtml)
                   throws SAXException,
IOException

Description copied from class: AbstractOOXMLExtractor

Populates the XHTMLContentHandler object received as parameter.

Specified by:

buildXHTML in class AbstractOOXMLExtractor

Throws:

SAXException

IOException

See Also:

• XSSFExcelExtractor.getText()

addDrawingHyperLinks

protected void addDrawingHyperLinks(org.apache.poi.openxml4j.opc.PackagePart sheetPart)

extractHyperLinks

protected void extractHyperLinks(org.apache.poi.openxml4j.opc.PackagePart sheetPart,
 XHTMLContentHandler xhtml)
                          throws SAXException

Throws:

SAXException

extractHeaderFooter

protected void extractHeaderFooter(String hf,
 XHTMLContentHandler xhtml)
                            throws SAXException

Throws:

SAXException

processDrawings

protected void processDrawings(org.apache.poi.openxml4j.opc.PackagePart sheetPart,
 XHTMLContentHandler xhtml)
                        throws SAXException

Throws:

SAXException

processSheet

public void processSheet(org.apache.tika.parser.microsoft.ooxml.TikaSheetContentsHandler sheetContentsHandler,
 org.apache.tika.parser.microsoft.ooxml.XSSFCommentsShim commentsShim,
 org.apache.tika.parser.microsoft.ooxml.XSSFStylesShim stylesShim,
 org.apache.tika.parser.microsoft.ooxml.XSSFSharedStringsShim stringsShim,
 InputStream sheetInputStream)
                  throws IOException,
SAXException

Throws:

IOException

SAXException

getMainDocumentParts

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

In Excel files, sheets have things embedded in them, and sheet drawings which have the images

Specified by:

getMainDocumentParts in class AbstractOOXMLExtractor

Throws:

TikaException

applyEmbeddedAnchorMetadata

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

Description copied from class: AbstractOOXMLExtractor

Hook for subclasses to apply anchor metadata (page or sheet numbers) to an embedded part's metadata, for paginated/sheeted containers. Called from AbstractOOXMLExtractor.handleEmbeddedFile(org.apache.poi.openxml4j.opc.PackagePart, org.apache.tika.sax.XHTMLContentHandler, java.lang.String, org.apache.tika.parser.microsoft.ooxml.EmbeddedPartMetadata, org.apache.tika.metadata.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(org.apache.tika.metadata.Metadata, java.util.Collection<java.lang.Integer>) (presentations) or PageAnchoring.applySheetMetadata(org.apache.tika.metadata.Metadata, java.util.Collection<java.lang.Integer>) (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.

Overrides:

applyEmbeddedAnchorMetadata in class AbstractOOXMLExtractor

Parameters:

part - the embedded part being emitted

metadata - metadata to enrich