com.paypal.selion.platform.dataprovider.impl

Class XmlDataProviderImpl

java.lang.Object

com.paypal.selion.platform.dataprovider.impl.XmlDataProviderImpl

All Implemented Interfaces:

SeLionDataProvider, XmlDataProvider

public final class XmlDataProviderImpl
extends Object
implements XmlDataProvider

This class provides several methods to retrieve test data from XML files. Users can get data returned in an Object 2D array by loading the XML file. If the entire XML file is not needed then specific data entries can be retrieved by indexes.

Constructor Summary

Constructors

Constructor and Description
XmlDataProviderImpl(XmlDataSource resource)

Method Summary

Methods

Modifier and Type	Method and Description
Object[][]	getAllData() Generates a two dimensional array for TestNG DataProvider from the XML data.
Object[][]	getAllKeyValueData() Generates a two dimensional array for TestNG DataProvider from the XML data representing a map of name value collection.
Hashtable<String,Object>	getDataAsHashtable() Gets xml data and returns in a hashtable instead of an Object 2D array.
Iterator<Object[]>	getDataByFilter(DataProviderFilter dataFilter) Generates an object array in iterator as TestNG DataProvider from the XML data filtered per dataFilter.
Object[][]	getDataByIndex(int[] indexes) Generates an object array in iterator as TestNG DataProvider from the XML data filtered per given indexes.
Object[][]	getDataByIndex(String filterIndexes) Generates an object array in iterator as TestNG DataProvider from the XML data filtered per given indexes string.
Object[][]	getDataByKeys(String[] keys) Generates a two dimensional array for TestNG DataProvider from the XML data representing a map of name value collection filtered by keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDataProviderImpl

public XmlDataProviderImpl(XmlDataSource resource)

Method Detail

getAllData

public Object[][] getAllData()

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

Specified by:

getAllData in interface SeLionDataProvider

Returns:

A two dimensional object array.

getDataByFilter

public Iterator<Object[]> getDataByFilter(DataProviderFilter dataFilter)

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

Specified by:

getDataByFilter in interface SeLionDataProvider

Parameters:

dataFilter - an implementation class of DataProviderFilter

Returns:

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

getDataByIndex

public Object[][] getDataByIndex(String filterIndexes)

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

Specified by:

getDataByIndex in interface SeLionDataProvider

Parameters:

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

Returns:

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

getDataByIndex

public Object[][] getDataByIndex(int[] indexes)

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

Specified by:

getDataByIndex in interface SeLionDataProvider

Parameters:

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

Returns:

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

getAllKeyValueData

public Object[][] getAllKeyValueData()

Generates a two dimensional array for TestNG DataProvider from the XML data representing a map of name value collection. This method needs the referenced DataResource to be instantiated using its constructors with parameter Class<?> cls and set to KeyValueMap.class. The implementation in this method is tightly coupled with KeyValueMap and KeyValuePair. The hierarchy and name of the nodes are strictly as instructed. A name value pair should be represented as nodes 'key' and 'value' as child nodes contained in a parent node named 'item'. A sample data with proper tag names is shown here as an example:

 
     
         k1
         val1
     
     
         k2
         val2
     
     
         k3
         val3
     
 
 

Specified by:

getAllKeyValueData in interface XmlDataProvider

Returns:

A two dimensional object array.

getDataByKeys

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

Generates a two dimensional array for TestNG DataProvider from the XML data representing a map of name value collection filtered by keys. A name value item should use the node name 'item' and a specific child structure since the implementation depends on KeyValuePair class. The structure of an item in collection is shown below where 'key' and 'value' are child nodes contained in a parent node named 'item':

 
     
         k1
         val1
     
     
         k2
         val2
     
     
         k3
         val3
     
 
 

Specified by:

getDataByKeys in interface SeLionDataProvider

Parameters:

keys - The string keys to filter the data.

Returns:

A two dimensional object array.

getDataAsHashtable

public Hashtable<String,Object> getDataAsHashtable()

Gets xml data and returns in a hashtable instead of an Object 2D array. Only compatible with a xml file formatted to return a map.

XML file example:

 
     
         k1
         val1
     
     
         k2
         val2
     
     
         k3
         val3
     
 
 

Specified by:

getDataAsHashtable in interface SeLionDataProvider

Returns:

xml data in form of a Hashtable.