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.
void	addDataSetsRevisions(String providerId, String dataSetId, eu.europeana.cloud.common.model.Revision revision, String representationName, String cloudId) Add information in additional table containing data sets cloud ids and revisions
void	addLatestRevisionForGivenVersionInDataset(eu.europeana.cloud.common.model.DataSet dataSet, eu.europeana.cloud.common.model.Representation representation, eu.europeana.cloud.common.model.Revision revision) Adds revision as a latest revision for given representation and dataset
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.
Set<String>	getAllDataSetRepresentationsNames(String providerId, String dataSetId) Lists all representations names that are included in given dataSet
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudVersionRevisionResponse>	getDataSetCloudIdsByRepresentationPublished(String dataSetId, String providerId, String representationName, Date dateFrom, String startFrom, int numberOfElementsPerPage) Lists all cloud identifiers that belong to data set from the specified provider and have revision timestamp bigger than the specified date and tag as specified.
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).
Map<String,Set<String>>	getDataSets(String cloudId, String representationName, String version) Returns all data sets for particular version.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudTagsResponse>	getDataSetsRevisions(String providerId, String dataSetId, String revisionProviderId, String revisionName, Date revisionTimestamp, String representationName, String startFrom, int limit) Lists all cloudId that are included in given dataSet for given revisionId and representationName.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudIdAndTimestampResponse>	getLatestDataSetCloudIdByRepresentationAndRevision(String dataSetId, String providerId, String revisionName, String revisionProvider, String representationName, String startFrom, Boolean isDeleted, int numberOfElementsPerPage) get a list of the latest cloud identifiers,revision timestamps that belong to data set of a specified provider for a specific representation and revision.
String	getLatestVersionForGivenRevision(String dataSetId, String providerId, String cloudId, String representationName, String revisionName, String revisionProviderId) Gives versionId of specified record (cloudId with representation name) that has latest revision
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, String versionId) Removes representation assignment from data set.
void	updateAllRevisionDatasetsEntries(String globalId, String schema, String version, eu.europeana.cloud.common.model.Revision revision) Inserts information to the all the tables which has dataset and revisions entries
eu.europeana.cloud.common.model.DataSet	updateDataSet(String providerId, String dataSetId, String description) Updates description of data set.
void	updateProviderDatasetRepresentation(String globalId, String schema, String version, eu.europeana.cloud.common.model.Revision revision) Inserts information to the table used to search for cloud ids assigned to a dataset having specific representation, revisions with published tag and update timestamp bigger that specified.

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,
                    String versionId)
                      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.

getDataSets

Map<String,Set<String>> getDataSets(String cloudId,
                                  String representationName,
                                  String version)

Returns all data sets for particular version.

Parameters:

cloudId - cloud Id

representationName - representation name

version - version

Returns:

Set of data sets.

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)

getAllDataSetRepresentationsNames

Set<String> getAllDataSetRepresentationsNames(String providerId,
                                            String dataSetId)
                                              throws ProviderNotExistsException,
                                                     DataSetNotExistsException

Lists all representations names that are included in given dataSet

Parameters:

providerId - dataset ovner id (provider id)

dataSetId - dataSet id

Returns:

list of all representations names that are stored in given dataSet

Throws:

ProviderNotExistsException

DataSetNotExistsException

getDataSetsRevisions

eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudTagsResponse> getDataSetsRevisions(String providerId,
                                                                                                                        String dataSetId,
                                                                                                                        String revisionProviderId,
                                                                                                                        String revisionName,
                                                                                                                        Date revisionTimestamp,
                                                                                                                        String representationName,
                                                                                                                        String startFrom,
                                                                                                                        int limit)
                                                                                                                          throws ProviderNotExistsException,
                                                                                                                                 DataSetNotExistsException

Lists all cloudId that are included in given dataSet for given revisionId and representationName.

Parameters:

providerId - dataSet owner

dataSetId - dataSet id

revisionProviderId - revision provider id

revisionName - revision name

revisionTimestamp - revision timestamp

representationName - representation name

startFrom - 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 cloudIds and tags in given dataSet for given revisionId and representationName.

Throws:

ProviderNotExistsException

DataSetNotExistsException

addDataSetsRevisions

void addDataSetsRevisions(String providerId,
                        String dataSetId,
                        eu.europeana.cloud.common.model.Revision revision,
                        String representationName,
                        String cloudId)
                          throws ProviderNotExistsException

Add information in additional table containing data sets cloud ids and revisions

Parameters:

providerId - data provider id

dataSetId - dataset id

revision - revision object

representationName - representation name

cloudId - cloud id

Throws:

ProviderNotExistsException

getDataSetCloudIdsByRepresentationPublished

eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudVersionRevisionResponse> getDataSetCloudIdsByRepresentationPublished(String dataSetId,
                                                                                                                                                          String providerId,
                                                                                                                                                          String representationName,
                                                                                                                                                          Date dateFrom,
                                                                                                                                                          String startFrom,
                                                                                                                                                          int numberOfElementsPerPage)
                                                                                                                                                            throws ProviderNotExistsException,
                                                                                                                                                                   DataSetNotExistsException

Lists all cloud identifiers that belong to data set from the specified provider and have revision timestamp bigger than the specified date and tag as specified.

Parameters:

dataSetId - data set identifier

providerId - provider identifier

representationName - representation name

dateFrom - date of latest revision

startFrom - cloudId to start from

numberOfElementsPerPage - number of elements in a slice

Returns:

list of cloud identifiers in the provider's data set having revision date bigger than the specified and specified tag

Throws:

ProviderNotExistsException

DataSetNotExistsException

RepresentationNotExistsException

getLatestDataSetCloudIdByRepresentationAndRevision

eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudIdAndTimestampResponse> getLatestDataSetCloudIdByRepresentationAndRevision(String dataSetId,
                                                                                                                                                             String providerId,
                                                                                                                                                             String revisionName,
                                                                                                                                                             String revisionProvider,
                                                                                                                                                             String representationName,
                                                                                                                                                             String startFrom,
                                                                                                                                                             Boolean isDeleted,
                                                                                                                                                             int numberOfElementsPerPage)
                                                                                                                                                               throws ProviderNotExistsException,
                                                                                                                                                                      DataSetNotExistsException

get a list of the latest cloud identifiers,revision timestamps that belong to data set of a specified provider for a specific representation and revision. This list will contain one row per revision per cloudId;

Parameters:

dataSetId - data set identifier

providerId - provider identifier

representationName - representation name

revisionName - revision name

revisionProvider - revision provider

startFrom - cloudId to start from

isDeleted - is marked deleted

numberOfElementsPerPage - number of elements in a slice

Returns:

slice of the latest cloud identifier,revision timestamp that belong to data set of a specified provider for a specific representation and revision. This list will contain one row per revision per cloudId ;

Throws:

ProviderNotExistsException

DataSetNotExistsException

updateAllRevisionDatasetsEntries

void updateAllRevisionDatasetsEntries(String globalId,
                                    String schema,
                                    String version,
                                    eu.europeana.cloud.common.model.Revision revision)
                                      throws RepresentationNotExistsException

Inserts information to the all the tables which has dataset and revisions entries

Parameters:

globalId - cloud identifier

schema - representation name

version - version identifier

revision - revision object containing necessary info (name, timestamp, tags)

Throws:

RepresentationNotExistsException

getLatestVersionForGivenRevision

String getLatestVersionForGivenRevision(String dataSetId,
                                      String providerId,
                                      String cloudId,
                                      String representationName,
                                      String revisionName,
                                      String revisionProviderId)
                                        throws DataSetNotExistsException

Gives versionId of specified record (cloudId with representation name) that has latest revision

Parameters:

dataSetId - dataset identifier

providerId - dataset owner

cloudId - representation cloud identifier

representationName - representation name

revisionName - revision name

revisionProviderId - revision owner

Returns:

Throws:

DataSetNotExistsException

addLatestRevisionForGivenVersionInDataset

void addLatestRevisionForGivenVersionInDataset(eu.europeana.cloud.common.model.DataSet dataSet,
                                             eu.europeana.cloud.common.model.Representation representation,
                                             eu.europeana.cloud.common.model.Revision revision)

Adds revision as a latest revision for given representation and dataset

Parameters:

dataSet -

representation -

revision -

updateProviderDatasetRepresentation

void updateProviderDatasetRepresentation(String globalId,
                                       String schema,
                                       String version,
                                       eu.europeana.cloud.common.model.Revision revision)
                                         throws RepresentationNotExistsException

Inserts information to the table used to search for cloud ids assigned to a dataset having specific representation, revisions with published tag and update timestamp bigger that specified. Data sets identifiers and their providers which are needed for every inserted row are determined from assignment between versions and data sets.

Parameters:

globalId - cloud identifier

schema - representation name

version - version identifier

revision - revision object containing necessary info (name, timestamp, tags)

Throws:

RepresentationNotExistsException