com.github.noraui.data.excel

Class ExcelDataProvider

java.lang.Object

com.github.noraui.data.CommonDataProvider

com.github.noraui.data.excel.ExcelDataProvider

All Implemented Interfaces:

DataInputProvider, DataOutputProvider, DataProvider

Direct Known Subclasses:

InputExcelDataProvider, OutputExcelDataProvider

public abstract class ExcelDataProvider
extends CommonDataProvider
implements DataInputProvider, DataOutputProvider

Nested Class Summary

Nested classes/interfaces inherited from class com.github.noraui.data.CommonDataProvider

CommonDataProvider.ResultColumnNames

Nested classes/interfaces inherited from interface com.github.noraui.data.DataProvider

DataProvider.type

Field Summary

Fields inherited from class com.github.noraui.data.CommonDataProvider

columns, dataInPath, dataOutPath, indexData, resultColumnName, scenarioName

Constructor Summary

Constructors

Constructor and Description
ExcelDataProvider()

Method Summary

Modifier and Type	Method and Description
int	getNbLines() Gets the number of readable lines of current opened file.
protected void	initColumns()
protected void	openInputData()
String[]	readLine(int line, boolean readResult)
String	readValue(String column, int line) Reads a cell of opened input file.
void	writeDataResult(String column, int line, String value) Writes some data as result.
void	writeFailedResult(int line, String value) Writes a fail result
void	writeSuccessResult(int line) Writes a success result
void	writeWarningResult(int line, String value) Writes a warning result

Methods inherited from class com.github.noraui.data.CommonDataProvider

getIndexData, getModel, getNbGherkinExample, getResultColumnName, isResultColumnNameAuthorized, setDataInPath, setDataOutPath, setIndexData, writeValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.noraui.data.DataProvider

getIndexData, getModel, getNbGherkinExample, getResultColumnName, isResultColumnNameAuthorized, prepare, setDataInPath, setDataOutPath, setIndexData

Constructor Detail

ExcelDataProvider

public ExcelDataProvider()

Method Detail

getNbLines

public int getNbLines()
               throws TechnicalException

Gets the number of readable lines of current opened file. If a line does not contain 'ID' column of if it is empty, then the line is not taken into account.

Specified by:

getNbLines in interface DataInputProvider

Returns:

number of opened input file

Throws:

TechnicalException - if Wrong data file (IOException, EmptyDataFileContentException or WrongDataFileFormatException)

writeFailedResult

public void writeFailedResult(int line,
                              String value)

Writes a fail result

Specified by:

writeFailedResult in interface DataOutputProvider

Overrides:

writeFailedResult in class CommonDataProvider

Parameters:

line - The line number

value - The value

writeSuccessResult

public void writeSuccessResult(int line)

Writes a success result

Specified by:

writeSuccessResult in interface DataOutputProvider

Overrides:

writeSuccessResult in class CommonDataProvider

Parameters:

line - The line number

writeWarningResult

public void writeWarningResult(int line,
                               String value)

Description copied from class: CommonDataProvider

Writes a warning result

Specified by:

writeWarningResult in interface DataOutputProvider

Overrides:

writeWarningResult in class CommonDataProvider

Parameters:

line - The line number

value - The value

writeDataResult

public void writeDataResult(String column,
                            int line,
                            String value)

Writes some data as result.

Specified by:

writeDataResult in interface DataOutputProvider

Overrides:

writeDataResult in class CommonDataProvider

Parameters:

column - The column name

line - The line number

value - The data value

readValue

public String readValue(String column,
                        int line)
                 throws TechnicalException

Reads a cell of opened input file.

Specified by:

readValue in interface DataInputProvider

Parameters:

column - index of the column to read

line - index of the line to read

Returns:

a String with the value of cell

Throws:

TechnicalException - if Wrong data file (IOException, EmptyDataFileContentException or WrongDataFileFormatException)

readLine

public String[] readLine(int line,
                         boolean readResult)
                  throws TechnicalException

Specified by:

readLine in interface DataInputProvider

Parameters:

line - id of the line to read (line=0 for reading headers ; line=1 for reading 1st line, ...)

readResult - true if result must be returned, false otherwise

Returns:

all content of read line split by cell in a String array

Throws:

TechnicalException - if Wrong data file (IOException, EmptyDataFileContentException or WrongDataFileFormatException)

initColumns

protected void initColumns()
                    throws EmptyDataFileContentException,
                           WrongDataFileFormatException

Throws:

EmptyDataFileContentException - if data is empty

WrongDataFileFormatException - if data is wrong

openInputData

protected void openInputData()
                      throws TechnicalException

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi.