nl.fountain.xelem.lex
Interface ExcelReaderListener

All Known Subinterfaces:

ExcelReaderFilter

All Known Implementing Classes:

DefaultExcelReaderFilter, DefaultExcelReaderListener, WorkbookListener

public interface ExcelReaderListener

Recieve notification of parsing events and the construction of XLElements. A registered ExcelReaderListener listens to events fired by ExcelReader while the ExcelReader is reading xml-spreadsheets of type spreadsheetML.

Since:

xelem.2.0

See Also:

package overview

Method Summary

void	endDocument(Map<String,String> prefixMap) Recieve notification of the end of the document.
void	endWorksheet(int sheetIndex, String sheetName) Recieve notification of the end of a worksheet.
void	processingInstruction(String target, String data) Recieve notification of processing instruction.
void	setAutoFilter(int sheetIndex, String sheetName, AutoFilter autoFilter) Recieve notification of the the construction of AutoFilter.
void	setCell(int sheetIndex, String sheetName, int rowIndex, Cell cell) Recieve notification of the the construction of a Cell.
void	setColumn(int sheetIndex, String sheetName, Column column) Recieve notification of the the construction of a Column.
void	setDocumentProperties(DocumentProperties docProps) Recieve notification of the the construction of DocumentProperties.
void	setExcelWorkbook(ExcelWorkbook excelWb) Recieve notification of the the construction of ExcelWorkbook.
void	setNamedRange(int sheetIndex, String sheetName, NamedRange namedRange) Recieve notification of the the construction of a NamedRange on the worksheet level.
void	setNamedRange(NamedRange namedRange) Recieve notification of the the construction of a NamedRange on the workbook level.
void	setRow(int sheetIndex, String sheetName, Row row) Recieve notification of the the construction of a Row.
void	setWorksheetOptions(int sheetIndex, String sheetName, WorksheetOptions wsOptions) Recieve notification of the the construction of WorksheetOptions.
void	startDocument() Recieve notification of the start of the document.
void	startTable(int sheetIndex, String sheetName, Table table) Recieve notification of the start of a Table tag.
void	startWorkbook(String systemID) Recieve notification of the start of the Workbook tag.
void	startWorksheet(int sheetIndex, Worksheet sheet) Recieve notification of the the start of a Worksheet tag.

Method Detail

startDocument

void startDocument()

Recieve notification of the start of the document.

processingInstruction

void processingInstruction(String target,
                           String data)

Recieve notification of processing instruction.

Parameters:

target - the target of the processing instruction

data - the data of the processing instruction

startWorkbook

void startWorkbook(String systemID)

Recieve notification of the start of the Workbook tag.

Parameters:

systemID - the systemID or "source" if no systemID was encountered

setDocumentProperties

void setDocumentProperties(DocumentProperties docProps)

Recieve notification of the the construction of DocumentProperties.

Parameters:

docProps - fully populated instance of DocumentProperties

setExcelWorkbook

void setExcelWorkbook(ExcelWorkbook excelWb)

Recieve notification of the the construction of ExcelWorkbook.

Parameters:

excelWb - fully populated instance of ExcelWorkbook

setNamedRange

void setNamedRange(NamedRange namedRange)

Recieve notification of the the construction of a NamedRange on the workbook level.

Parameters:

namedRange - fully populated instance of NamedRange

startWorksheet

void startWorksheet(int sheetIndex,
                    Worksheet sheet)

Recieve notification of the the start of a Worksheet tag.

Parameters:

sheetIndex - the index of the encountered sheet. 0-based.

sheet - dummy instance of Worksheet. Only the (xml-)attributes of the Worksheet-element have been set on the instance

setNamedRange

void setNamedRange(int sheetIndex,
                   String sheetName,
                   NamedRange namedRange)

Recieve notification of the the construction of a NamedRange on the worksheet level.

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the namedRange was found

namedRange - fully populated instance of NamedRange

startTable

void startTable(int sheetIndex,
                String sheetName,
                Table table)

Recieve notification of the start of a Table tag.

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the table was found

table - dummy instance of Table. Only the (xml-)attributes of the Table-element have been set on the instance

setColumn

void setColumn(int sheetIndex,
               String sheetName,
               Column column)

Recieve notification of the the construction of a Column. The column is fully populated, it's column index has been set and can be obtained by column.getIndex().

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the column was found

column - fully populated instance of Column

setRow

void setRow(int sheetIndex,
            String sheetName,
            Row row)

Recieve notification of the the construction of a Row. The row is fully populated, it's row index has been set and can be obtained by row.getIndex().

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the row was found

row - fully populated instance of Row

setCell

void setCell(int sheetIndex,
             String sheetName,
             int rowIndex,
             Cell cell)

Recieve notification of the the construction of a Cell. The cell is fully populated, it's cell index has been set and can be obtained by cell.getIndex().

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the cell was found

rowIndex - the index of the row

cell - fully populated instance of Cell

setWorksheetOptions

void setWorksheetOptions(int sheetIndex,
                         String sheetName,
                         WorksheetOptions wsOptions)

Recieve notification of the the construction of WorksheetOptions.

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the worksheetOptions was found

wsOptions - fully populated instance of WorksheetOptions

setAutoFilter

void setAutoFilter(int sheetIndex,
                   String sheetName,
                   AutoFilter autoFilter)

Recieve notification of the the construction of AutoFilter.

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet where the autoFilter was found

autoFilter - fully populated instance of AutoFilter

endWorksheet

void endWorksheet(int sheetIndex,
                  String sheetName)

Recieve notification of the end of a worksheet.

Parameters:

sheetIndex - the index of the worksheet (0-based)

sheetName - the name of the worksheet

endDocument

void endDocument(Map<String,String> prefixMap)

Recieve notification of the end of the document.

Parameters:

prefixMap - a map of prefixes (keys) and uri's recieved while reading