com.segue.scc.published.api.datasource85

Interface DataSource

public interface DataSource

A DataSource knows how it gets it's 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.

Method Summary

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.

Method Detail

getName

java.lang.String getName()

getDataSets

DataSet[] getDataSets()
               throws DataSourceException

Throws:

DataSourceException

getPropertyProvider

PropertyProvider getPropertyProvider()

getStringResolver

StringResolver getStringResolver()

validate

void validate()
       throws DataSourceException

When a DataSource is configured and the user confirms the settings, this is called to check if the configuration is valid. If the configuration isn't valid, the DataSource should provide a useful and nice message in the DataSourceException that will be displayed to the user.

Throws:

DataSourceException

isFileDataSource

boolean isFileDataSource()

The DataSource must provide information, if the data comes from a local file. If this is true, the configuration enables to select a file in a SourceControl system. This call must succeed even if the DataSource has no DataSourceConfiguration set.

Returns:

whether the plugin reads data from a file in the Filesystem or not

getFileExtensions

java.lang.String[] getFileExtensions()

If the plugin is a file based Data Source this method returns the allowed file extensions.

Returns:

Array of allowed file extensions or a empty Array when the plugin is not file based

getAvailableValues

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.

Parameters:

parameterName -

Returns:

the selectable values

Throws:

java.lang.IllegalArgumentException - if a non-any-select property is passed

stringifyMultiSelect

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. This is because the plugin is also required to understand this string.

Parameters:

selectedValues -

Returns:

the string representation of the multi-select.