Package org.apache.poi.hssf.extractor

Class OldExcelExtractor

java.lang.Object

org.apache.poi.hssf.extractor.OldExcelExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, POITextExtractor

public class OldExcelExtractor
extends Object
implements POITextExtractor

A text extractor for old Excel files, which are too old for HSSFWorkbook to handle. This includes Excel 95, and very old (pre-OLE2) Excel files, such as Excel 4 files.

Returns much (but not all) of the textual content of the file, suitable for indexing by something like Apache Lucene, or used by Apache Tika, but not really intended for display to the user.

Constructor Summary

Constructors

Constructor	Description
OldExcelExtractor(File f)
OldExcelExtractor(InputStream input)
OldExcelExtractor(DirectoryNode directory)
OldExcelExtractor(POIFSFileSystem fs)

Method Summary

Modifier and Type	Method	Description
int	getBiffVersion()	The Biff version, largely corresponding to the Excel version
Object	getDocument()
Closeable	getFilesystem()
int	getFileType()	The kind of the file, one of BOFRecord.TYPE_WORKSHEET, BOFRecord.TYPE_CHART, BOFRecord.TYPE_EXCEL_4_MACRO or BOFRecord.TYPE_WORKSPACE_FILE
POITextExtractor	getMetadataTextExtractor()	Returns another text extractor, which is able to output the textual content of the document metadata / properties, such as author and title.
String	getText()	Retrieves the text contents of the file, as best we can for these old file formats
protected void	handleNumericCell(StringBuilder text, double value)
boolean	isCloseFilesystem()
static void	main(String[] args)
void	setCloseFilesystem(boolean doCloseFilesystem)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.extractor.POITextExtractor

close

Constructor Detail

OldExcelExtractor

public OldExcelExtractor(InputStream input)
                  throws IOException

Throws:

IOException

OldExcelExtractor

public OldExcelExtractor(File f)
                  throws IOException

Throws:

IOException

OldExcelExtractor

public OldExcelExtractor(POIFSFileSystem fs)
                  throws IOException

Throws:

IOException

OldExcelExtractor

public OldExcelExtractor(DirectoryNode directory)
                  throws IOException

Throws:

IOException

Method Detail

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException

getBiffVersion

public int getBiffVersion()

The Biff version, largely corresponding to the Excel version

Returns:

the Biff version

getFileType

public int getFileType()

The kind of the file, one of BOFRecord.TYPE_WORKSHEET, BOFRecord.TYPE_CHART, BOFRecord.TYPE_EXCEL_4_MACRO or BOFRecord.TYPE_WORKSPACE_FILE

Returns:

the file type

getText

public String getText()

Retrieves the text contents of the file, as best we can for these old file formats

Specified by:

getText in interface POITextExtractor

Returns:

the text contents of the file

handleNumericCell

protected void handleNumericCell(StringBuilder text,
                                 double value)

getMetadataTextExtractor

public POITextExtractor getMetadataTextExtractor()

Description copied from interface: POITextExtractor

Returns another text extractor, which is able to output the textual content of the document metadata / properties, such as author and title.

Specified by:

getMetadataTextExtractor in interface POITextExtractor

Returns:

the metadata and text extractor

setCloseFilesystem

public void setCloseFilesystem(boolean doCloseFilesystem)

Specified by:

setCloseFilesystem in interface POITextExtractor

Parameters:

doCloseFilesystem - true (default), if underlying resources/filesystem should be closed on POITextExtractor.close()

isCloseFilesystem

public boolean isCloseFilesystem()

Specified by:

isCloseFilesystem in interface POITextExtractor

Returns:

true, if resources/filesystem should be closed on POITextExtractor.close()

getFilesystem

public Closeable getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem

getDocument

public Object getDocument()

Specified by:

getDocument in interface POITextExtractor

Returns:

the processed document