public interface DataSource
DataSets and also how to get the actual
data and how to get
metaInfo.
Implementations of this class must have a default constructor and a constructor getting a
DataSourceConfiguration as a parameter.
| Modifier and Type | Method and Description |
|---|---|
java.lang.String[] |
getAvailableValues(java.lang.String parameterName)
When the returned
PropertyProvider returns a property of type
MULTISELECT or
SINGLESELECT this method will be called
with the corresponding property to get the currently possible values. |
DataSet[] |
getDataSets() |
java.lang.String[] |
getFileExtensions()
If the plugin is a file based Data Source this method returns the allowed file extensions.
|
java.lang.String |
getName() |
PropertyProvider |
getPropertyProvider() |
StringResolver |
getStringResolver() |
boolean |
isFileDataSource()
The DataSource must provide information, if the data comes from a local file.
|
java.lang.String |
stringifyMultiSelect(java.lang.String[] selectedValues)
When
getAvailableValues(String) is used, the selection is returned here and it's up to the plugin to
render the selected values into a single string. |
void |
validate()
When a DataSource is configured and the user confirms the settings, this is called to check if the configuration
is valid.
|
java.lang.String getName()
DataSet[] getDataSets() throws DataSourceException
DataSourceExceptionPropertyProvider getPropertyProvider()
StringResolver getStringResolver()
void validate()
throws DataSourceException
DataSourceExceptionboolean isFileDataSource()
DataSourceConfiguration set.java.lang.String[] getFileExtensions()
java.lang.String[] getAvailableValues(java.lang.String parameterName)
PropertyProvider returns a property of type
MULTISELECT or
SINGLESELECT this method will be called
with the corresponding property to get the currently possible values.parameterName - java.lang.IllegalArgumentException - if a non-any-select property is passedjava.lang.String stringifyMultiSelect(java.lang.String[] selectedValues)
getAvailableValues(String) is used, the selection is returned here and it's up to the plugin to
render the selected values into a single string. This is because the plugin is also required to understand this
string.selectedValues - Copyright © Micro Focus 2004-2019. All rights reserved.