Package csv.impl

Class ExcelReader

java.lang.Object

csv.impl.AbstractTableReader

csv.impl.AbstractStreamTableReader

csv.impl.ExcelReader

All Implemented Interfaces:

TableReader, Iterable<Object[]>, Iterator<Object[]>

public class ExcelReader
extends AbstractStreamTableReader

Implements Excel reading.

This class reads Excel sheets like a stream, meaning delivering rows one by one from the current sheet. Use this reader if you want to load an Excel file by creating a File and passing it to the constructor.

Example:

java.io.File f = new java.io.File("excel-test.xls");
ExcelReader in = new ExcelReader(f);
while (in.hasNext()) {
    Object columns[] = in.next();
    // Do something here
}
in.close();

Author:

RalphSchuster

See Also:

selectSheet(int), selectSheet(String)

Constructor Summary

Constructors

Constructor	Description
ExcelReader()	Default constructor.
ExcelReader(File file)	Constructor for reading from a file.
ExcelReader(InputStream in)	Constructor to read from an existing stream.
ExcelReader(String file)	Constructor for reading from a file.
ExcelReader(org.apache.poi.ss.usermodel.Workbook workbook)	Constructor to read from an existing workbook.

Method Summary

Modifier and Type	Method	Description
int	computeMaxColumnCount()	Computes the max row length of any rows in this sheet.
Object	evaluateCellValue(org.apache.poi.ss.usermodel.Cell cell)	Returns the evaluated cell content.
org.apache.poi.ss.usermodel.FormulaEvaluator	getFormulaEvaluator()	Returns a formula evaluator for the current workbook.
org.apache.poi.ss.usermodel.Row	getLastExcelRow()	Returns the last delivered row.
protected org.apache.poi.ss.usermodel.Row	getOrCreateRow(int rowNum)	Ensures that the sheet contains a row at the given index.
org.apache.poi.ss.usermodel.Sheet	getSheet()	Returns the current sheet.
Object	getValue(int rownum, int cellNum)	Returns the value of the specified cell.
Object	getValue(org.apache.poi.ss.usermodel.Cell cell)	Returns the value of the specified cell.
Object	getValue(org.apache.poi.ss.usermodel.Row row, int cellNum)	Returns the value of the specified cell.
Object[]	getValues(int rowNum)	Returns the row at the given index.
Object[]	getValues(org.apache.poi.ss.usermodel.Row row)	Returns the row as Java objects.
org.apache.poi.ss.usermodel.Workbook	getWorkbook()	Returns the workbook.
boolean	hasNext()	Returns whether there is a row to be read in the current sheet.
boolean	isEvaluateFormulas()	Returns whether formulas shall be evaluated or not (default is true).
boolean	isSkipBlankRows()	Returns whether blank rows will be skipped or not while reading.
Object[]	next()	Returns the next row.
void	open()	Opens the stream by retrieving the workbook and selecting the first sheet.
protected void	readHeaderRow()	Reads the header row from next line.
void	reset()	Resets the reader by resetting the current row index
protected void	retrieveNextRow()	Retrieves the next row from the current sheet.
protected boolean	rowHasOnlyBlankCells(org.apache.poi.ss.usermodel.Row row)	Checks whether row has only blank cells.
org.apache.poi.ss.usermodel.Sheet	selectSheet(int index)	Select the given sheet to be read from.
org.apache.poi.ss.usermodel.Sheet	selectSheet(String name)	Select the given sheet to be read from.
org.apache.poi.ss.usermodel.Sheet	selectSheet(org.apache.poi.ss.usermodel.Sheet sheet)	Select the given sheet to be read from.
void	setEvaluateFormulas(boolean evaluateFormulas)	Sets whether formulas shall be evaluated or not (default is true).
void	setSkipBlankRows(boolean skipBlankRows)	Sets whether blank rows will be skipped or not while reading.

Methods inherited from class csv.impl.AbstractStreamTableReader

close, createInputStreamReader, createReader, getCharsetDecoder, getInputStream, getReader, remove, setCharset, setCharset, setCharsetDecoder, setInputStream

Methods inherited from class csv.impl.AbstractTableReader

addCommentCallBack, convert, convert, convertArray, convertArray, get, getColumnIndex, getColumnType, getHeaderRow, getLineCount, getMinimumColumnCount, getRowCount, getTypeConversionHandler, hasHeaderRow, incrementLineCount, incrementRowCount, isHeaderRowRead, iterator, notifyComment, registerCommentCallBack, registerTypeConversionHandler, removeCommentCallBack, setColumnType, setHasHeaderRow, setHeaderRow, setHeaderRowRead, setMinimumColumnCount, unregisterCommentCallBack, unregisterTypeConversionHandler

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelReader

public ExcelReader()

Default constructor.

ExcelReader

public ExcelReader(File file)
            throws FileNotFoundException

Constructor for reading from a file.

Parameters:

file - file to read from

Throws:

FileNotFoundException - when file does not exist

ExcelReader

public ExcelReader(InputStream in)

Constructor to read from an existing stream.

Parameters:

in - input stream to be used

ExcelReader

public ExcelReader(org.apache.poi.ss.usermodel.Workbook workbook)

Constructor to read from an existing workbook.

Parameters:

workbook - the workbook be used

ExcelReader

public ExcelReader(String file)
            throws FileNotFoundException

Constructor for reading from a file.

Parameters:

file - file to read from

Throws:

FileNotFoundException - when file does not exist

Method Detail

open

public void open()

Opens the stream by retrieving the workbook and selecting the first sheet.

Specified by:

open in interface TableReader

Overrides:

open in class AbstractTableReader

See Also:

AbstractTableReader.open()

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

Returns the workbook.

Returns:

workbook

isSkipBlankRows

public boolean isSkipBlankRows()

Returns whether blank rows will be skipped or not while reading.

Returns:

true when blank rows are skipped (default), false otherwise

setSkipBlankRows

public void setSkipBlankRows(boolean skipBlankRows)

Sets whether blank rows will be skipped or not while reading.

Parameters:

skipBlankRows - true when blank rows are skipped (default), false otherwise

computeMaxColumnCount

public int computeMaxColumnCount()

Computes the max row length of any rows in this sheet.

Returns:

int length

selectSheet

public org.apache.poi.ss.usermodel.Sheet selectSheet(String name)

Select the given sheet to be read from.

Parameters:

name - name of sheet

Returns:

sheet selected

selectSheet

public org.apache.poi.ss.usermodel.Sheet selectSheet(org.apache.poi.ss.usermodel.Sheet sheet)

Select the given sheet to be read from.

Parameters:

sheet - sheet to be selected

Returns:

sheet selected

selectSheet

public org.apache.poi.ss.usermodel.Sheet selectSheet(int index)

Select the given sheet to be read from.

Parameters:

index - index of sheet

Returns:

sheet selected

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

Returns the current sheet.

Returns:

the current sheet.

getLastExcelRow

public org.apache.poi.ss.usermodel.Row getLastExcelRow()

Returns the last delivered row. This is the row delivered by last call to next().

Returns:

the last row delivered by next()

reset

public void reset()

Resets the reader by resetting the current row index

Specified by:

reset in interface TableReader

Overrides:

reset in class AbstractStreamTableReader

See Also:

AbstractStreamTableReader.reset(), AbstractTableReader.getRowCount()

hasNext

public boolean hasNext()

Returns whether there is a row to be read in the current sheet. This implementation stops reading when last row from a sheet was read. You might need to manually select the next sheet if you want to read more rows from other sheets.

Returns:

true if a row is available in current sheet.

See Also:

Iterator.hasNext(), selectSheet(int)

next

public Object[] next()

Returns the next row. This method increases the internal row index and delivers the next row in the sheet. Values in the array are Java objects depending on the cell type. If the cell contained a formula, the formula is evaluated before returning the row.

Returns:

values in row

See Also:

Iterator.next(), AbstractTableReader.getRowCount()

getValues

public Object[] getValues(int rowNum)

Returns the row at the given index. Values in the array are Java objects depending on the cell type. If the cell contained a formula, the formula is evaluated before returning the row.

Parameters:

rowNum - row index to read

Returns:

values of row

getValues

public Object[] getValues(org.apache.poi.ss.usermodel.Row row)

Returns the row as Java objects. Values in the array are Java objects depending on the cell type. If the cell contained a formula, the formula is evaluated before returning the row.

Parameters:

row - row to read

Returns:

values in row

getValue

public Object getValue(int rownum,
                       int cellNum)

Returns the value of the specified cell. If the cell contained a formula, the formula is evaluated before returning the row.

Parameters:

rownum - row index

cellNum - column index

Returns:

value of cell

getValue

public Object getValue(org.apache.poi.ss.usermodel.Row row,
                       int cellNum)

Returns the value of the specified cell. If the cell contained a formula, the formula is evaluated before returning the row.

Parameters:

row - row object

cellNum - column index

Returns:

value of cell

getValue

public Object getValue(org.apache.poi.ss.usermodel.Cell cell)

Returns the value of the specified cell. If the cell contained a formula, the formula is evaluated before returning the row.

Parameters:

cell - cell object

Returns:

value of cell

evaluateCellValue

public Object evaluateCellValue(org.apache.poi.ss.usermodel.Cell cell)

Returns the evaluated cell content. This assumes the cell contains a formula.

Parameters:

cell - cell to evaluate

Returns:

cell value

getFormulaEvaluator

public org.apache.poi.ss.usermodel.FormulaEvaluator getFormulaEvaluator()

Returns a formula evaluator for the current workbook. This is for convinience.

Returns:

the formula evaluator

isEvaluateFormulas

public boolean isEvaluateFormulas()

Returns whether formulas shall be evaluated or not (default is true).

Returns:

true when formulas are evaluated

setEvaluateFormulas

public void setEvaluateFormulas(boolean evaluateFormulas)

Sets whether formulas shall be evaluated or not (default is true).

Parameters:

evaluateFormulas - true or false

readHeaderRow

protected void readHeaderRow()

Reads the header row from next line.

Overrides:

readHeaderRow in class AbstractTableReader

See Also:

AbstractTableReader.readHeaderRow()

retrieveNextRow

protected void retrieveNextRow()

Retrieves the next row from the current sheet. The row is then internally stored for evaluation of hasNext() and next(). Blank rows are skipped when isSkipBlankRows() return true.

rowHasOnlyBlankCells

protected boolean rowHasOnlyBlankCells(org.apache.poi.ss.usermodel.Row row)

Checks whether row has only blank cells. The method is called from retrieveNextRow().

Parameters:

row - the row to check

Returns:

boolean when the row has only blank cells

getOrCreateRow

protected org.apache.poi.ss.usermodel.Row getOrCreateRow(int rowNum)

Ensures that the sheet contains a row at the given index.

Parameters:

rowNum - index of row

Returns:

the row from the sheet or a new blank row