Dataset Catalog Connector
The Purpose
The extension point DatasetCatalogConnector allows for supporting a variety of dataset catalogs.
The Model
A DatasetCatalogConnector (it.uniroma2.art.semanticturkey.extension.extpts.datasetcatalog.DatasetCatalogConnector)
defines a number of operations that allow to search a dataset in a certain catalog and to obtain its associated metadata.
Extension Point Details
The tables below summarizes the details of the
DatasetCatalogConnector extension point.
| Name |
Dataset Catalog Connector |
| Description |
This extension point allows for connecting Semantic Turkey to (usually remote) dataset catalogs |
| Identifier |
it.uniroma2.art.semanticturkey.extension.extpts.datasetcatalog.DatasetCatalogConnector |
| Configuration |
n/a |
| Settings |
n/a |
Interfaces
The following interface defines the contract for the DatasetCatalogConnector extension point.
/**
* This extension point allows for connecting Semantic Turkey to (usually remote) dataset catalogs.
*
*/
public interface DatasetCatalogConnector extends Extension {
SearchResultsPage<DatasetSearchResult> searchDataset(String query, Map<String, List<String>> facets,
int page) throws IOException;
DatasetDescription describeDataset(String id) throws IOException;
default SearchFacet[] getDatasetSearchFacets() {
// omit default implementation
}
// ...
}
Choosing and Configuring a Dataset Catalog Connector
A DatasetCatalogConnector is created on the fly, Semantic Turkey assumes that the new instance does not require
any configuration upon instantiation, while actual configuration is (optionally) stored in system-level settings. These
settings are stored according to the standard configuration/settings mechanism.
Dataset Catalog Connector
LOV Connector
| Name |
LOV Connector |
| Description |
A DatasetCatalogConnector for LOV (Linked Open Vocabularies) |
| Identifier |
it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.lov.LOVConnector |
| Configuration |
n/a
|
| Settings |
n/a
|
LOD Cloud Connector
| Name |
LOD Cloud Connector |
| Description |
A DatasetCatalogConnector for Linked Open Data Cloud |
| Identifier |
it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.lodcloud.LODCloudConnector |
| Configuration |
n/a
|
| Settings |
n/a
|
data.europa.eu Connector
| Name |
data.europa.eu Connector |
| Description |
A DatasetCatalogConnector for data.europa.eu |
| Identifier |
it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.dataeu.DataEUConnector |
| Configuration |
n/a
|
| Settings |
n/a
|
ShowVoc Connector
| Name |
ShowVoc Connector |
| Description |
A DatasetCatalogConnector for ShowVoc, an open-source software to set up data portals |
| Identifier |
it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.showvoc.ShowVocConnector |
| Configuration |
Scopes:
SYSTEM,
PROJECT,
USER,
PROJECT_USER
ShowVoc Connector (it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.showvoc.ShowVocConnectorConfiguration)
|
API base URL (apiBaseURL) |
| The base URL of an implementation of the ShowVoc REST API. The connector constructs the URL of the requested operations, by appending their relative address to the value of the parameter. |
java.lang.String
|
| Required |
|
Frontend base URL (frontendBaseURL) |
| The base URL of the frontend of a ShowVoc instance. The value of this optional parameter is used to provide the links to the datasets in the dataset portals returned by the API operations. |
boolean
|
| Optional |
|
|
| Settings |
n/a
|
OntoPortal Connector
| Name |
OntoPortal Connector |
| Description |
A DatasetCatalogConnector for repositories backed by OntoPortal |
| Identifier |
it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.ontoportal.OntoPortalConnector |
| Configuration |
Scopes:
SYSTEM,
PROJECT,
USER,
PROJECT_USER
OntoPortal (it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.ontoportal.OntoPortalConnectorConfiguration)
|
Frontend base URL (frontendBaseURL) |
| The base URL of the OntoPortal frontend. |
java.lang.String
|
| Required |
|
API base URL (apiBaseURL) |
| API base URL. If no value is provided, it will be used the one for the property rest_url in the configuration object returned by /site_config at the frontend base URL |
java.lang.String
|
| Optional |
|
API key (apiKey) |
| A valid API key for the OntoPortal REST API. A user's API key be found on the account page of that user. If no value is provided, it will be used the one for the property apikey in the configuration object returned by /site_config at the frontend base URL |
java.lang.String
|
| Optional |
|
Retrieve submissions (retrieveSubmissions) |
| Retrieve the latest submissions for all ontologies, and join them with the retrieved ontologies. Consequently, search results will include additional facets and metadata (e.g., description) |
java.lang.Boolean
|
| Optional |
|
EcoPortal (it.uniroma2.art.semanticturkey.extension.impl.datasetcatalog.ontoportal.OntoPortalConnectorConfiguration)
|
Frontend base URL (frontendBaseURL) |
| The base URL of the OntoPortal frontend. If no value is provided, it will be used the official address of EcoPortal |
java.lang.String
|
| Optional |
|
API base URL (apiBaseURL) |
| API base URL. If no value is provided, it will be used the one for the property rest_url in the configuration object returned by /site_config at the frontend base URL |
java.lang.String
|
| Optional |
|
API key (apiKey) |
| A valid API key for the OntoPortal REST API. A user's API key be found on the account page of that user. If no value is provided, it will be used the one for the property apikey in the configuration object returned by /site_config at the frontend base URL |
java.lang.String
|
| Optional |
|
Retrieve submissions (retrieveSubmissions) |
| Retrieve the latest submissions for all ontologies, and join them with the retrieved ontologies. Consequently, search results will include additional facets and metadata (e.g., description) |
java.lang.Boolean
|
| Optional |
|
|
| Settings |
n/a
|
