Package com.xceptance.xlt.api.data

# Interface DataSetProvider

public interface DataSetProvider
A `DataSetProvider` implementation reads one or more test data sets from a data file and returns them to the XLT framework, which in turn executes a certain test case once for each data set (data-driven tests). Note that this feature is currently supported for script test cases only. The framework searches for test data files that are associated with script test cases and reads them in using one of the known data set providers.

The XLT framework already knows some default data set providers for common file formats:

- .csv - data sets are read from CSV files
- .sql - data sets are read from a JDBC data source
- .xml - data sets are read from an XML file

Custom implementations might override existing providers or add providers for new file formats. This is done by configuration, for example in file "project.properties". Use the following property syntax:

     com.xceptance.xlt.data.dataSetProviders.<extension> = <class>

To register class "com.yourcompany.FooDataSetProvider" for data set files with the extension ".foo", you need to configure the following property:

     com.xceptance.xlt.data.dataSetProviders.foo = com.yourcompany.FooDataSetProvider

- ## Method Summary

  Modifier and Type
  Method
  Description
  `List<Map<String,String>>`
  `getAllDataSets(File dataFile)`
  Returns all data sets managed by this data set provider.

- ## Method Details

  - ### getAllDataSets

    List<Map<String,String>> getAllDataSets(File dataFile) throws DataSetProviderException
    Returns all data sets managed by this data set provider.
    Parameters:
      `dataFile` - the data file
    Returns:
      the list of data sets
    Throws:
      `DataSetProviderException` - if an error occurred