The DataSourcesProcerties interface is used as a parameter to the handleComparatorsDataSources described in Step 4: Define Data Source Handling (Optional). The methods in the class are listed and described below.
The getDataSourcesList returns the comparator's list of associated data source paths.
List getDataSourcesList(String codeName)
Parameter |
Type |
Description |
---|---|---|
codeName |
string |
The name of the comparator. The name is defined in comparatorsList.xml in the name attribute of the code element. In the example below, the comparator's code name is “Exact”. <code description="New exact comparator" name="Exact" /> |
A list of paths and filenames as specified in comparatorsList.xml.
None.
The isDataSourceLoaded method checks whether a specific file has already been loaded or opened.
boolean isDataSourceLoaded(String sourcePath)
Parameter |
Type |
Description |
---|---|---|
sourcePath |
string |
The path and filename of the file to check. |
A boolean indicator of whether the specified file has already been loaded or opened.
None.
The setDataSourceLoaded method sets the loading status of a data source.
void setDataSourceLoaded(String sourcePath, boolean status)
Parameter |
Type |
Description |
---|---|---|
sourcePath |
string |
The path and filename of the file. |
status |
boolean |
The load status of the file. Specify true if the file is loaded; otherwise specify false. |
None.
None.
The getDataSourceObject method returns the file located at the specified source path.
Object getDataSourceObject(String sourcePath)
Parameter |
Type |
Description |
---|---|---|
sourcePath |
string |
The path and filename of the file you want to load. |
An object containing the data source information.
None.