eu.europeana.cloud.service.mcs

Interface DataSetService

public interface DataSetService

Service for data sets and representation assignments to data sets.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAssignment(String providerId, String dataSetId, String recordId, String schema, String version) Assigns a representation in predefined or latest version to a data set.
eu.europeana.cloud.common.model.DataSet	createDataSet(String providerId, String dataSetId, String description) Creates a new data set for specified provider.
void	deleteDataSet(String providerId, String dataSetId) Deletes data set.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataSet>	getDataSets(String providerId, String thresholdDatasetId, int limit) Returns all data sets for particular data provider (in slices).
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.Representation>	listDataSet(String providerId, String dataSetId, String thresholdParam, int limit) Returns all representations from particular data set (in slices).
void	removeAssignment(String providerId, String dataSetId, String recordId, String schema) Removes representation assignment from data set.
eu.europeana.cloud.common.model.DataSet	updateDataSet(String providerId, String dataSetId, String description) Updates description of data set.

Method Detail

listDataSet

eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.Representation> listDataSet(String providerId,
                                                                                                         String dataSetId,
                                                                                                         String thresholdParam,
                                                                                                         int limit)
                                                                                                           throws DataSetNotExistsException

Returns all representations from particular data set (in slices). If data set contains representation not in specified version, the latest persistent representation version will be returned.

Parameters:

providerId - provider's (owner of data set) id.

dataSetId - data set id

thresholdParam - if null - will return first result slice. Result slices contain token for next pages, which should be provided in this parameter.

limit - max number of results in one slice.

Returns:

list of representations as a result slice.

Throws:

DataSetNotExistsException - dataset not exists.

addAssignment

void addAssignment(String providerId,
                 String dataSetId,
                 String recordId,
                 String schema,
                 String version)
                   throws DataSetNotExistsException,
                          RepresentationNotExistsException

Assigns a representation in predefined or latest version to a data set. Temporary representation may be added to a data set only if version is provided. If the same representation was already assigned to a data set, version of representation will be overwritten by provided in this method.

Parameters:

providerId - owner of data set

dataSetId - data set id

recordId - id of record

schema - schema name of representation

version - version of representatnion (if null, the latest persistent version is assigned to a data set)

Throws:

DataSetNotExistsException - if such data set not exists

RepresentationNotExistsException - if such representation does not exist. May be also thrown if version is not provided and no persistent representation version exist for specified schema and record.

removeAssignment

void removeAssignment(String providerId,
                    String dataSetId,
                    String recordId,
                    String schema)
                      throws DataSetNotExistsException

Removes representation assignment from data set.

Parameters:

providerId - owner of data set

dataSetId - data set id

recordId - id of record

schema - schema name of representation

Throws:

DataSetNotExistsException - if such data set not exists

createDataSet

eu.europeana.cloud.common.model.DataSet createDataSet(String providerId,
                                                    String dataSetId,
                                                    String description)
                                                      throws ProviderNotExistsException,
                                                             DataSetAlreadyExistsException

Creates a new data set for specified provider.

Parameters:

providerId - owner of data set

dataSetId - identifier of newly created data set

description - description of newly created data set (may be any text)

Returns:

created data set.

Throws:

ProviderNotExistsException - no such data provider exists

DataSetAlreadyExistsException - data set with this identifer has already been created for this provider

updateDataSet

eu.europeana.cloud.common.model.DataSet updateDataSet(String providerId,
                                                    String dataSetId,
                                                    String description)
                                                      throws DataSetNotExistsException

Updates description of data set.

Parameters:

providerId - owner of data set

dataSetId - identifier of newly created data set

description - new description of data set (may be any text)

Returns:

updated data set

Throws:

DataSetNotExistsException

getDataSets

eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataSet> getDataSets(String providerId,
                                                                                                  String thresholdDatasetId,
                                                                                                  int limit)

Returns all data sets for particular data provider (in slices).

Parameters:

providerId - provider id.

thresholdDatasetId - if null - will return first result slice. Result slices contain token for next pages, which should be provided in this parameter.

limit - max number of results in one slice.

Returns:

list of data sets as a result slice.

deleteDataSet

void deleteDataSet(String providerId,
                 String dataSetId)
                   throws DataSetNotExistsException

Deletes data set.

Parameters:

providerId - provider id

dataSetId - data set id.

Throws:

DataSetNotExistsException - no such data set exists (data provider does not have one or data provider not exist)