org.apache.poi.xssf.binary

Interface XSSFBSheetHandler.XSSFBSheetContentsHandler

Enclosing class:

XSSFBSheetHandler

public static interface XSSFBSheetHandler.XSSFBSheetContentsHandler

Receives streaming callbacks while XSSFBSheetHandler parses an XLSB sheet.

Since:

POI 5.5.0

See Also:

XSSFBSheetHandler

Method Summary

Modifier and Type	Method and Description
void	booleanCell(String cellReference, boolean value, XSSFComment comment) Handles a boolean cell.
void	doubleCell(String cellReference, double value, XSSFComment comment, ExcelNumberFormat nf) Handles a numeric cell while providing the corresponding ExcelNumberFormat.
void	endRow(int rowNum) Signals that a row has ended after all of its cells and comments were processed.
void	endSheet() Signals that the sheet has been completely processed.
void	errorCell(String cellReference, FormulaError fe, XSSFComment comment) Handles a cell that evaluates to an error.
void	headerFooter(String text, boolean isHeader, String tagName) Receives header or footer text encountered in the sheet.
void	startRow(int rowNum) Signals that a row has started before any of its cells are delivered.
void	stringCell(String cellReference, String value, XSSFComment comment) Handles a cell that resolves to a string value, possibly representing a comment-only cell.

Method Detail

startRow

void startRow(int rowNum)

Signals that a row has started before any of its cells are delivered.

Parameters:

rowNum - zero-based row index

See Also:

endRow(int)

endRow

void endRow(int rowNum)

Signals that a row has ended after all of its cells and comments were processed.

Parameters:

rowNum - zero-based row index

See Also:

startRow(int)

stringCell

void stringCell(String cellReference,
                String value,
                XSSFComment comment)

Handles a cell that resolves to a string value, possibly representing a comment-only cell.

Parameters:

cellReference - A1-style cell address

value - string contents, or null if only a comment is present

comment - associated comment, or null if absent

Sheets that have missing or empty cells may result in sparse calls to cell . See the code in poi-examples/src/main/java/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java for an example of how to handle this scenario.

See Also:

doubleCell(String, double, XSSFComment, ExcelNumberFormat)

doubleCell

void doubleCell(String cellReference,
                double value,
                XSSFComment comment,
                ExcelNumberFormat nf)

Handles a numeric cell while providing the corresponding ExcelNumberFormat.

Parameters:

cellReference - A1-style cell address

value - numeric value extracted from the sheet

comment - associated comment, or null if absent

nf - number format describing how the value should be rendered

Sheets that have missing or empty cells may result in sparse calls to cell . See the code in poi-examples/src/main/java/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java for an example of how to handle this scenario.

See Also:

stringCell(String, String, XSSFComment)

booleanCell

void booleanCell(String cellReference,
                 boolean value,
                 XSSFComment comment)

Handles a boolean cell.

Parameters:

cellReference - A1-style cell address

value - boolean value stored in the cell

comment - associated comment, or null if absent

Sheets that have missing or empty cells may result in sparse calls to cell . See the code in poi-examples/src/main/java/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java for an example of how to handle this scenario.

See Also:

stringCell(String, String, XSSFComment)

errorCell

void errorCell(String cellReference,
               FormulaError fe,
               XSSFComment comment)

Handles a cell that evaluates to an error.

Parameters:

cellReference - A1-style cell address

fe - mapped FormulaError, or null when the error code is unknown

comment - associated comment, or null if absent

Sheets that have missing or empty cells may result in sparse calls to cell . See the code in poi-examples/src/main/java/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java for an example of how to handle this scenario.

See Also:

FormulaError

headerFooter

void headerFooter(String text,
                  boolean isHeader,
                  String tagName)

Receives header or footer text encountered in the sheet.

Parameters:

text - resolved header or footer text

isHeader - true when the text belongs to a header, otherwise false

tagName - POI-internal tag representing the header or footer section

See Also:

endSheet()

endSheet

void endSheet()

Signals that the sheet has been completely processed.

See Also:

startRow(int)