Top Description Methods
org.apache.poi.ss.extractor

public Interface ExcelExtractor

Known Direct Implementers
org.apache.poi.hssf.extractor.EventBasedExcelExtractor, org.apache.poi.hssf.extractor.ExcelExtractor

Common interface for Excel text extractors, covering HSSF and XSSF

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the text contents of the file
getText
()

Retrieves the text contents of the file

public void
setFormulasNotResults(boolean
true if the formula itself is returned
formulasNotResults
)

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

public void
setIncludeCellComments(boolean
true if cell comments should be included
includeCellComments
)

Should cell comments be included?

public void
setIncludeHeadersFooters(boolean
true if headers and footers should be included
includeHeadersFooters
)

Should headers and footers be included in the output?

public void
setIncludeSheetNames(boolean
true if the sheet names should be included
includeSheetNames
)

Should sheet names be included?

Method Detail

getTextback to summary
public String getText()

Retrieves the text contents of the file

Returns:String

the text contents of the file

setFormulasNotResultsback to summary
public void setFormulasNotResults(boolean formulasNotResults)

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

Parameters
formulasNotResults:boolean

true if the formula itself is returned

setIncludeCellCommentsback to summary
public void setIncludeCellComments(boolean includeCellComments)

Should cell comments be included? Default is false

Parameters
includeCellComments:boolean

true if cell comments should be included

setIncludeHeadersFootersback to summary
public void setIncludeHeadersFooters(boolean includeHeadersFooters)

Should headers and footers be included in the output? Default is true

Parameters
includeHeadersFooters:boolean

true if headers and footers should be included

setIncludeSheetNamesback to summary
public void setIncludeSheetNames(boolean includeSheetNames)

Should sheet names be included? Default is true

Parameters
includeSheetNames:boolean

true if the sheet names should be included