eu.europeana.cloud.migrator

Interface ResourceProvider

All Known Implementing Classes:

DefaultResourceProvider, EuropeanaNewspapersResourceProvider, FoodAndDrinkResourceProvider, RoyalArmoryResourceProvider

public interface ResourceProvider

Method Summary

Methods

Modifier and Type	Method and Description
String	getDataProviderId(String path) Returns the data provider identifier used in ECloud.
eu.europeana.cloud.common.model.DataProviderProperties	getDataProviderProperties(String path) Get basic information on data provider such as organisation name, address and others.
int	getFileCount(String localId) Determine the number of files that should be added for the specified local identifier.
String	getFilename(String location, String path) Determines user filename from the specified path to file and location.
String	getLocalIdentifier(String location, String path, boolean duplicate) Get local identifier of the record for the specified path to file and provider identifier.
List<URI>	getLocations() Return resource provider location as URI.
String	getRepresentationName() Return the default representation name of records added for this resource provider.
String	getResourceProviderId(String path) Get resource provider identifier as string.
Map<String,String>	getReversedMapping() Mapping file can associate local record identifier with a set of paths to files.
boolean	isLocal() Checks whether the provider location is local.
Map<String,List<FilePaths>>	scan() Scan location in case it's local.
List<FilePaths>	split(List<FilePaths> paths) Resource provider implementation may split the file paths that will be migrated into several parts.
boolean	usePathsFile() Indicates whether file paths to process should be stored in a file.

Method Detail

getResourceProviderId

String getResourceProviderId(String path)

Get resource provider identifier as string. Resource provider is usually institution that has its directory within the resource location. It is NOT the data provider used in ECloud however the same identifier may be used.

Parameters:

path - path to resource

Returns:

resource provider identifier

getDataProviderId

String getDataProviderId(String path)

Returns the data provider identifier used in ECloud. Usually it is the same for all ResourceProvider records and it's defined in configuration file.

Parameters:

path - path to file that may be used to determine the data provider identifier if it's not defined in configuration

Returns:

data provider identifier for ECloud

getDataProviderProperties

eu.europeana.cloud.common.model.DataProviderProperties getDataProviderProperties(String path)

Get basic information on data provider such as organisation name, address and others. See DataProviderProperties for details.

Parameters:

path - path to directory where the data provider properties file is located

Returns:

data provider properties

getLocalIdentifier

String getLocalIdentifier(String location,
                        String path,
                        boolean duplicate)

Get local identifier of the record for the specified path to file and provider identifier.

Parameters:

location - location of the file path

path - path to file

duplicate - indicate whether this may be a duplicate

Returns:

local identifier of the record

getRepresentationName

String getRepresentationName()

Return the default representation name of records added for this resource provider. The representation name is the same for all records within one run of migration tool.

Returns:

default representation name

getLocations

List<URI> getLocations()

Return resource provider location as URI. This may indicate directory or remote resource URL.

Returns:

resource provider locaction as URI

isLocal

boolean isLocal()

Checks whether the provider location is local.

Returns:

true when location is local or false otherwise

scan

Map<String,List<FilePaths>> scan()

Scan location in case it's local. Otherwise return an empty map. The returned map should associate provider identifier (it can be determined from the path) with the list of files to add.

Returns:

map of provider identifiers associated to the list of paths to files

getFilename

String getFilename(String location,
                 String path)

Determines user filename from the specified path to file and location.

Parameters:

location - location where the path is placed, usually needed to determine file path relative to location

path - path to file either local or remote in URI syntax

Returns:

filename to be stored in ECloud

getFileCount

int getFileCount(String localId)

Determine the number of files that should be added for the specified local identifier. It may be done using the mapping file or any other way proper for the resource provider. When it is impossible to determine -1 is returned.

Parameters:

localId - local identifier of the record

Returns:

number of files the record should have or -1 if it's impossible to determine

split

List<FilePaths> split(List<FilePaths> paths)

Resource provider implementation may split the file paths that will be migrated into several parts. The way of splitting is specific for a resource provider. The idea of splitting the file paths is to use many threads during the migration process. For each FilePaths object there will be a separate thread.

Parameters:

paths - paths to files that will be migrated

Returns:

a list of lists

usePathsFile

boolean usePathsFile()

Indicates whether file paths to process should be stored in a file. If false they are stored in memory.

Returns:

true when paths should be stored in a file or false otherwise

getReversedMapping

Map<String,String> getReversedMapping()

Mapping file can associate local record identifier with a set of paths to files. Internally mapping is stored in a reversed form since the lookups are done using path to file and not the local identifier. This method returns reversed mapping.

Returns:

reversed mapping