com.paypal.selion.platform.dataprovider

Interface ExcelDataProvider

All Superinterfaces:

SeLionDataProvider

All Known Implementing Classes:

ExcelDataProviderImpl

public interface ExcelDataProvider
extends SeLionDataProvider

This interface defines prototype to implement excel data provider implementation to parse excel format data file.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomTypes(DefaultCustomType type)
List<org.apache.poi.ss.usermodel.Row>	getAllRawExcelRows(String sheetName, boolean heading) Get all excel rows from a specified sheet.
List<String>	getRowContents(String sheetName, int rowIndex, int size) Using the specified rowIndex to search for the row from the specified Excel sheet, then return the row contents in a list of string format.
Object	getSingleExcelRow(int index) This method can be used to fetch a particular row from an excel sheet.
Object	getSingleExcelRow(String key) This method fetches a specific row from an excel sheet which can be identified using a key and returns the data as an Object which can be cast back into the user's actual data type.

Methods inherited from interface com.paypal.selion.platform.dataprovider.SeLionDataProvider

getAllData, getDataAsHashtable, getDataByFilter, getDataByIndex, getDataByIndex, getDataByKeys

Method Detail

getSingleExcelRow

Object getSingleExcelRow(String key)

This method fetches a specific row from an excel sheet which can be identified using a key and returns the data as an Object which can be cast back into the user's actual data type.

Parameters:

key - - A string that represents a key to search for in the excel sheet

Returns:

- An Object which can be cast into the user's actual data type.

getSingleExcelRow

Object getSingleExcelRow(int index)

This method can be used to fetch a particular row from an excel sheet.

Parameters:

index - - The row number from the excel sheet that is to be read. For e.g., if you wanted to read the 2nd row (which is where your data exists) in your excel sheet, the value for index would be 1. This method assumes that your excel sheet would have a header which it would EXCLUDE. When specifying index value always remember to ignore the header, since this method will look for a particular row ignoring the header row.

Returns:

- An object that represents the data for a given row in the excel sheet.

getRowContents

List<String> getRowContents(String sheetName,
                          int rowIndex,
                          int size)

Using the specified rowIndex to search for the row from the specified Excel sheet, then return the row contents in a list of string format.

Parameters:

rowIndex - - The row number from the excel sheet that is to be read. For e.g., if you wanted to read the 2nd row (which is where your data exists) in your excel sheet, the value for index would be 1. This method assumes that your excel sheet would have a header which it would EXCLUDE. When specifying index value always remember to ignore the header, since this method will look for a particular row ignoring the header row.

size - - The number of columns to read, including empty and blank column.

Returns:

List String array contains the row data.

getAllRawExcelRows

List<org.apache.poi.ss.usermodel.Row> getAllRawExcelRows(String sheetName,
                                                       boolean heading)

Get all excel rows from a specified sheet.

Parameters:

sheetName - - A String that represents the Sheet name from which data is to be read

heading - - If true, will return all rows along with the heading row. If false, will return all rows except the heading row.

Returns:

- A List of Row that are read.

addCustomTypes

void addCustomTypes(DefaultCustomType type)

Parameters:

type - - A DefaultCustomType that represents custom types that need to be taken into consideration when generating an Object that represents every row of data from the excel sheet.