org.apache.poi.hssf.extractor
Class ExcelExtractor

java.lang.Object
  org.apache.poi.POITextExtractor
      org.apache.poi.POIOLE2TextExtractor
          org.apache.poi.hssf.extractor.ExcelExtractor

public class ExcelExtractor
extends POIOLE2TextExtractor

A text extractor for Excel files. Returns the textual content of the file, suitable for indexing by something like Lucene, but not really intended for display to the user. To turn an excel file into a CSV or similar, then see the XLS2CSVmra example

See Also:

XLS2CSVmra

Field Summary

Fields inherited from class org.apache.poi.POITextExtractor

document

Constructor Summary

ExcelExtractor(HSSFWorkbook wb)

ExcelExtractor(POIFSFileSystem fs)

Method Summary

java.lang.String	getText() Retreives the text contents of the file
void	setFormulasNotResults(boolean formulasNotResults) Should we return the formula itself, and not the result it produces? Default is false
void	setIncludeCellComments(boolean includeCellComments) Should cell comments be included? Default is true
void	setIncludeSheetNames(boolean includeSheetNames) Should sheet names be included? Default is true

Methods inherited from class org.apache.poi.POIOLE2TextExtractor

getDocSummaryInformation, getSummaryInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelExtractor

public ExcelExtractor(HSSFWorkbook wb)

ExcelExtractor

public ExcelExtractor(POIFSFileSystem fs)
               throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setIncludeSheetNames

public void setIncludeSheetNames(boolean includeSheetNames)

Should sheet names be included? Default is true

setFormulasNotResults

public void setFormulasNotResults(boolean formulasNotResults)

Should we return the formula itself, and not the result it produces? Default is false

setIncludeCellComments

public void setIncludeCellComments(boolean includeCellComments)

Should cell comments be included? Default is true

getText

public java.lang.String getText()

Retreives the text contents of the file

Specified by:

getText in class POITextExtractor

Returns:

All the text from the document