com.paypal.selion.platform.dataprovider

Interface SeLionDataProvider

All Known Subinterfaces:

ExcelDataProvider, XmlDataProvider

All Known Implementing Classes:

ExcelDataProviderImpl, JsonDataProviderImpl, XmlDataProviderImpl, YamlDataProviderImpl

public interface SeLionDataProvider

This interface defines prototype to implement own data provider implementation to parse the specific format data file. User can create own data provider by implementing this interface.

Method Summary

Methods

Modifier and Type	Method and Description
Object[][]	getAllData() Generates a two dimensional array for TestNG DataProvider from the data file.
Hashtable<String,Object>	getDataAsHashtable() A utility method to give output data as HashTable.
Iterator<Object[]>	getDataByFilter(DataProviderFilter dataFilter) Generates an object array in iterator as TestNG DataProvider from the data filtered per dataFilter.
Object[][]	getDataByIndex(int[] indexes) Generates an object array in iterator as TestNG DataProvider from the data filtered per given indexes.
Object[][]	getDataByIndex(String indexes) Generates an object array in iterator as TestNG DataProvider from the data filtered per given indexes string.
Object[][]	getDataByKeys(String[] keys) Generates a two dimensional array for TestNG DataProvider from the data representing a map of name value collection filtered by keys.

Method Detail

getAllData

Object[][] getAllData()
                      throws IOException

Generates a two dimensional array for TestNG DataProvider from the data file.

Returns:

A two dimensional object array

Throws:

IOException

getDataByFilter

Iterator<Object[]> getDataByFilter(DataProviderFilter dataFilter)
                                   throws IOException

Generates an object array in iterator as TestNG DataProvider from the data filtered per dataFilter.

Parameters:

dataFilter - an implementation class of DataProviderFilter

Returns:

An iterator over a collection of Object Array to be used with TestNG DataProvider

Throws:

IOException

getDataByIndex

Object[][] getDataByIndex(String indexes)
                          throws IOException

Generates an object array in iterator as TestNG DataProvider from the data filtered per given indexes string. This method may throw DataProviderException when an unexpected error occurs during data provision from data file.

Parameters:

indexes - The indexes for which data is to be fetched as a conforming string pattern.

Returns:

Object[][] to be used with TestNG DataProvider.

Throws:

IOException

getDataByIndex

Object[][] getDataByIndex(int[] indexes)
                          throws IOException

Generates an object array in iterator as TestNG DataProvider from the data filtered per given indexes. This method may throw DataProviderException when an unexpected error occurs during data provision from data file.

Parameters:

indexes - The indexes for which data is to be fetched as a conforming string pattern.

Returns:

Object[][] to be used with TestNG DataProvider.

Throws:

IOException

getDataByKeys

Object[][] getDataByKeys(String[] keys)

Generates a two dimensional array for TestNG DataProvider from the data representing a map of name value collection filtered by keys.

Parameters:

keys - The string keys to filter the data.

Returns:

A two dimensional object array.

getDataAsHashtable

Hashtable<String,Object> getDataAsHashtable()

A utility method to give output data as HashTable.

Returns:

The data as a Hashtable