org.openepics.cable.services.dl

Interface DataStream

All Known Implementing Classes:

DataStreamExcel

public interface DataStream

This represents a data stream from which the data is loaded.

Author:

Vasu Vuppala, Sunil Sah

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 index) Returns the data in a cell from the current row.
Object	getCell(int rowIndex, int colIndex) Returns a data in a cell for given row.
String	getColumnLabel(int index) 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)

Method Detail

open

void open(InputStream stream)

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

Parameters:

stream - the stream to read from

nextRow

void nextRow()

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

getCell

Object getCell(int index)

Returns the data in a cell from the current row.

Parameters:

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

Returns:

the data in this cell

getRowSize

int getRowSize()

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

Returns:

the row size

isEndOfStream

boolean isEndOfStream()

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

Returns:

true if the end was reached

close

void close()

Closes the stream releasing all resources associated to it.

getColumnLabel

String getColumnLabel(int index)

Returns the label of the column.

Parameters:

index - the 0-based index of the column

Returns:

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

getRowIndex

int getRowIndex()

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

Returns:

the row index, or -1 if no current row

getRowLabel

String getRowLabel()

Returns the label of the currently read row.

Returns:

the row label

containsMergedCells

boolean containsMergedCells()

Returns true if current row contains merged cells.

Returns:

true if current row contains merged cells otherwise false.

getMergedRegions

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

Returns list of merged regions of the current row.

Returns:

list of merged regions.

getCell

Object getCell(int rowIndex,
               int colIndex)

Returns a data in a cell for given row.

Parameters:

rowIndex - row index

colIndex - column index

Returns:

data in a cell.

getUrlColumns

List<Integer> getUrlColumns()

Returns:

the urlColumns

setUrlColumns

void setUrlColumns(List<Integer> urlColumns)

Parameters:

urlColumns - the urlColumns to set