org.mazarineblue.datasources

Class ExcelSource

java.lang.Object

org.mazarineblue.datasources.AbstractSource

org.mazarineblue.datasources.MatrixSource

org.mazarineblue.datasources.ExcelSource

All Implemented Interfaces:

DataSource, VariableSource

public class ExcelSource
extends MatrixSource

Author:

Alex de Kruijff <alex.de.kruijff@MazarineBlue.org>

Constructor Summary

Constructors

Constructor and Description
ExcelSource(String sourceIdentifier, org.apache.poi.ss.usermodel.Sheet sheet) Opens a sheet of an excel file as a DataSource.
ExcelSource(String sourceIdentifier, org.apache.poi.ss.usermodel.Sheet sheet, boolean hasHeader) Opens a sheet of an excel file as a DataSource.

Method Summary

Modifier and Type	Method and Description
Object	getData(int index)
String	getLineIdentifier() Returns the line identifier.
boolean	hasNext() Return true if the data source has more rows.
String	next() Moves the data source to the next row.
String	reset() Resets the data source.
boolean	setData(int index, Object value) Sets the specified value to the specivied column.
boolean	setData(String column, Object value) Return the object at the specified index.

Methods inherited from class org.mazarineblue.datasources.MatrixSource

getColumns, getData, hasHeaders

Methods inherited from class org.mazarineblue.datasources.AbstractSource

getSourceIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mazarineblue.datasources.DataSource

getData, getData, reset

Constructor Detail

ExcelSource

public ExcelSource(String sourceIdentifier,
                   org.apache.poi.ss.usermodel.Sheet sheet,
                   boolean hasHeader)
            throws DataValidationException

Opens a sheet of an excel file as a DataSource.

Parameters:

sourceIdentifier - the name of this source

sheet - the excel sheet specified sheet.

hasHeader - true when the first line contains the header

Throws:

DataValidationException - when the header does not contain all strings.

ExcelSource

public ExcelSource(String sourceIdentifier,
                   org.apache.poi.ss.usermodel.Sheet sheet)

Opens a sheet of an excel file as a DataSource. The source does not contain a header line.

Parameters:

sourceIdentifier - the name of this source

sheet - the excel sheet specified sheet.

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: DataSource

Return true if the data source has more rows.

Returns:

true if the data source has more rows.

next

public String next()

Description copied from interface: DataSource

Moves the data source to the next row.

Returns:

the line identifier of the next row.

reset

public String reset()

Description copied from interface: DataSource

Resets the data source.

Returns:

the line identifier from before reset was called or null, if next was not called.

getLineIdentifier

public String getLineIdentifier()
                         throws IllegalSourceStateException

Description copied from interface: DataSource

Returns the line identifier.

Returns:

the line identifier.

Throws:

IllegalSourceStateException - when the method could not be called due to the state of the source i.e. next() has not been called or this method is not supported by the data source. when next() has not been

getData

public Object getData(int index)
               throws IllegalSourceStateException

Throws:

IllegalSourceStateException

setData

public boolean setData(String column,
                       Object value)
                throws Exception

Description copied from interface: DataSource

Return the object at the specified index.

Specified by:

setData in interface DataSource

Specified by:

setData in interface VariableSource

Overrides:

setData in class MatrixSource

Parameters:

column - the location where the object should be stored.

value - the object to store.

Returns:

the object at the specified index or null if it could not be fetched.

Throws:

Exception

setData

public boolean setData(int index,
                       Object value)

Description copied from interface: DataSource

Sets the specified value to the specivied column.

Parameters:

index - the location where the object should be stored.

value - the object to store.

Returns:

the object at the specified index or null if it could not be fetched.