Package org.apache.tika.parser.microsoft

Class ExcelExtractor

java.lang.Object

org.apache.tika.parser.microsoft.ExcelExtractor

public class ExcelExtractor
extends Object

Excel parser implementation which uses POI's Event API to handle the contents of a Workbook.

The Event API uses a much smaller memory footprint than HSSFWorkbook when processing excel files but at the cost of more complexity.

With the Event API a listener is registered for specific record types and those records are created, fired off to the listener and then discarded as the stream is being processed.

See Also:

HSSFListener, POI Event API How To

Constructor Summary

Constructors

Constructor	Description
ExcelExtractor(ParseContext context, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
boolean	isListenForAllRecords()	Returns true if this parser is configured to listen for all records instead of just the specified few.
void	setListenForAllRecords(boolean listenForAllRecords)	Specifies whether this parser should to listen for all records or just for the specified few.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelExtractor

public ExcelExtractor(ParseContext context,
                      Metadata metadata)

Method Detail

isListenForAllRecords

public boolean isListenForAllRecords()

Returns true if this parser is configured to listen for all records instead of just the specified few.

setListenForAllRecords

public void setListenForAllRecords(boolean listenForAllRecords)

Specifies whether this parser should to listen for all records or just for the specified few.

Note: Under normal operation this setting should be false (the default), but you can experiment with this setting for testing and debugging purposes.

Parameters:

listenForAllRecords - true if the HSSFListener should be registered to listen for all records or false if the listener should be configured to only receive specified records.