org.openepics.cable.services.dl

Class DataStreamExcel

java.lang.Object

org.openepics.cable.services.dl.DataStreamExcel

All Implemented Interfaces:

DataStream

public class DataStreamExcel
extends Object
implements DataStream

This is an implementation of DataStream that retrieves the data from an Excel spreadsheet.

Author:

Vasu Vuppala, Sunil Sah

Constructor Summary

Constructors

Constructor and Description
DataStreamExcel()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream releasing all resources associated to it.
boolean	containsMergedCells() Returns true if current row contains merged cells.
Object	getCell(int colNum) Returns the data in a cell from the current row.
Object	getCell(int rowNum, int colNum) Returns a data in a cell for given row.
String	getColumnLabel(int colNum) Returns the label of the column.
List<org.apache.poi.ss.util.CellRangeAddress>	getMergedRegions() Returns list of merged regions of the current row.
int	getRowIndex() Returns the 0-based index of the currently read row.
String	getRowLabel() Returns the label of the currently read row.
int	getRowSize() Returns the row size, that is the number of columns of this row.
List<Integer>	getUrlColumns()
boolean	isEndOfStream() Returns true if the end of the stream has been reached, and there is no more data.
void	nextRow() Switches to the next row.
void	open(InputStream stream) Opens the given stream to read data from.
void	setUrlColumns(List<Integer> urlColumns)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataStreamExcel

public DataStreamExcel()

Method Detail

getUrlColumns

public List<Integer> getUrlColumns()

Specified by:

getUrlColumns in interface DataStream

Returns:

the urlColumns

setUrlColumns

public void setUrlColumns(List<Integer> urlColumns)

Specified by:

setUrlColumns in interface DataStream

Parameters:

urlColumns - the urlColumns to set

open

public void open(InputStream stream)

Description copied from interface: DataStream

Opens the given stream to read data from. After this call, this object owns the stream.

Specified by:

open in interface DataStream

Parameters:

stream - the stream to read from

close

public void close()

Description copied from interface: DataStream

Closes the stream releasing all resources associated to it.

Specified by:

close in interface DataStream

nextRow

public void nextRow()

Description copied from interface: DataStream

Switches to the next row. Call this after opening the stream to get data for the first row.

Specified by:

nextRow in interface DataStream

getCell

public Object getCell(int colNum)

Description copied from interface: DataStream

Returns the data in a cell from the current row.

Specified by:

getCell in interface DataStream

Parameters:

colNum - the 0-based index of the cell column, should be less than row size.

Returns:

the data in this cell

getCell

public Object getCell(int rowNum,
                      int colNum)

Description copied from interface: DataStream

Returns a data in a cell for given row.

Specified by:

getCell in interface DataStream

Parameters:

rowNum - row index

colNum - column index

Returns:

data in a cell.

containsMergedCells

public boolean containsMergedCells()

Description copied from interface: DataStream

Returns true if current row contains merged cells.

Specified by:

containsMergedCells in interface DataStream

Returns:

true if current row contains merged cells otherwise false.

getMergedRegions

public List<org.apache.poi.ss.util.CellRangeAddress> getMergedRegions()

Description copied from interface: DataStream

Returns list of merged regions of the current row.

Specified by:

getMergedRegions in interface DataStream

Returns:

list of merged regions.

getRowSize

public int getRowSize()

Description copied from interface: DataStream

Returns the row size, that is the number of columns of this row.

Specified by:

getRowSize in interface DataStream

Returns:

the row size

isEndOfStream

public boolean isEndOfStream()

Description copied from interface: DataStream

Returns true if the end of the stream has been reached, and there is no more data.

Specified by:

isEndOfStream in interface DataStream

Returns:

true if the end was reached

getColumnLabel

public String getColumnLabel(int colNum)

Description copied from interface: DataStream

Returns the label of the column.

Specified by:

getColumnLabel in interface DataStream

Parameters:

colNum - the 0-based index of the column

Returns:

the column label (A, B, C...)

getRowIndex

public int getRowIndex()

Description copied from interface: DataStream

Returns the 0-based index of the currently read row.

Specified by:

getRowIndex in interface DataStream

Returns:

the row index, or -1 if no current row

getRowLabel

public String getRowLabel()

Description copied from interface: DataStream

Returns the label of the currently read row.

Specified by:

getRowLabel in interface DataStream

Returns:

the row label