com.github.noraui.data

Class CommonDataProvider

java.lang.Object

com.github.noraui.data.CommonDataProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

CsvDataProvider, DBDataProvider, ExcelDataProvider, InputGherkinDataProvider, OutputConsoleDataProvider, RestDataProvider

public abstract class CommonDataProvider
extends Object
implements DataProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CommonDataProvider.ResultColumnNames Class that manages available column names used in Data Providers.

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

DataProvider.type

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	columns
protected String	dataInPath
protected String	dataOutPath
protected List<DataIndex>	indexData
protected String	resultColumnName
protected String	scenarioName

Constructor Summary

Constructors

Constructor and Description
CommonDataProvider()

Method Summary

Modifier and Type	Method and Description
DataIndex	getIndexData(int dataLine) get IndexData in case of serial data.
Class<Model>	getModel(String modelPackagesCsv)
int	getNbGherkinExample()
String	getResultColumnName() Getter of resultName column name.
boolean	isResultColumnNameAuthorized(String name) Returns true if the given column name is part of authorized column names.
void	setDataInPath(String dataInPath) Setter of dataInPath.
void	setDataOutPath(String dataOutPath) Setter of dataOutPath.
void	setIndexData(List<DataIndex> indexDataIn) set IndexData in case of serial data.
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
protected void	writeValue(String column, int line, String value) Defines how to write values.
void	writeWarningResult(int line, String value) Writes a warning result

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

prepare

Field Detail

dataInPath

protected String dataInPath

dataOutPath

protected String dataOutPath

indexData

protected List<DataIndex> indexData

scenarioName

protected String scenarioName

columns

protected List<String> columns

resultColumnName

protected String resultColumnName

Constructor Detail

CommonDataProvider

public CommonDataProvider()

Method Detail

getNbGherkinExample

public int getNbGherkinExample()

Specified by:

getNbGherkinExample in interface DataProvider

setIndexData

public void setIndexData(List<DataIndex> indexDataIn)

set IndexData in case of serial data.

Specified by:

setIndexData in interface DataProvider

Parameters:

indexDataIn - is a array of index in case of serial data.

getIndexData

public DataIndex getIndexData(int dataLine)

get IndexData in case of serial data.

Specified by:

getIndexData in interface DataProvider

Parameters:

dataLine - is index of line in case of serial data.

Returns:

noraui.data.DataIndex

getModel

public Class<Model> getModel(String modelPackagesCsv)
                      throws TechnicalException

Specified by:

getModel in interface DataProvider

Parameters:

modelPackagesCsv - The list of available package in which to search for a valid Model (in CSV format with ; separator).

Returns:

An instance of Class that can be mapped with ExcelDataProvider data.

Throws:

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

setDataInPath

public void setDataInPath(String dataInPath)

Setter of dataInPath.

Specified by:

setDataInPath in interface DataProvider

Parameters:

dataInPath - the new data in path

setDataOutPath

public void setDataOutPath(String dataOutPath)

Setter of dataOutPath.

Specified by:

setDataOutPath in interface DataProvider

Parameters:

dataOutPath - the new data out path

getResultColumnName

public String getResultColumnName()

Getter of resultName column name.

Specified by:

getResultColumnName in interface DataProvider

Returns:

the name of the result column

writeFailedResult

public void writeFailedResult(int line,
                              String value)

Writes a fail result

Parameters:

line - The line number

value - The value

writeSuccessResult

public void writeSuccessResult(int line)

Writes a success result

Parameters:

line - The line number

writeWarningResult

public void writeWarningResult(int line,
                               String value)

Writes a warning result

Parameters:

line - The line number

value - The value

writeDataResult

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

Writes some data as result.

Parameters:

column - The column name

line - The line number

value - The data value

writeValue

protected void writeValue(String column,
                          int line,
                          String value)

Defines how to write values. This method is a stub and must be overridden by children classes.

Parameters:

column - The column name

line - The line number

value - The value to write

isResultColumnNameAuthorized

public boolean isResultColumnNameAuthorized(String name)

Returns true if the given column name is part of authorized column names. See CommonDataProvider.ResultColumnNames class.

Specified by:

isResultColumnNameAuthorized in interface DataProvider

Parameters:

name - the name to check

Returns:

true if the name is authorized, false otherwise