eu.europeana.cloud.migrator

Class EuropeanaNewspapersResourceProvider

java.lang.Object

eu.europeana.cloud.migrator.DefaultResourceProvider

eu.europeana.cloud.migrator.EuropeanaNewspapersResourceProvider

All Implemented Interfaces:

ResourceProvider

public class EuropeanaNewspapersResourceProvider
extends DefaultResourceProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMAGE_DIR

Fields inherited from class eu.europeana.cloud.migrator.DefaultResourceProvider

CONTACT_PERSON_KEY, dataProviderId, DEFAULT_CONTACT_PERSON, DEFAULT_DIGITAL_LIBRARY_WEBSITE, DEFAULT_DIGITAL_LIBRARY_WEBSITE_URL, DEFAULT_OFFICIAL_ADDRESS, DEFAULT_ORGANISATION_NAME, DEFAULT_ORGANISATION_WEBSITE, DEFAULT_ORGANISATION_WEBSITE_URL, DEFAULT_REMARKS, DIGITAL_LIBRARY_WEBSITE_KEY, DIGITAL_LIBRARY_WEBSITE_URL_KEY, local, locations, mappingFile, OFFICIAL_ADDRESS_KEY, ORGANISATION_NAME_KEY, ORGANISATION_WEBSITE_KEY, ORGANISATION_WEBSITE_URL_KEY, PROPERTIES_EXTENSION, REMARKS_KEY, representationName

Constructor Summary

Constructors

Constructor and Description
EuropeanaNewspapersResourceProvider(String representationName, String mappingFile, String locations, String dataProviderId)

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	getLocalIdentifier(String location, String path, boolean duplicate) Get local identifier of the record for the specified path to file and provider identifier.
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.
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.

Methods inherited from class eu.europeana.cloud.migrator.DefaultResourceProvider

getDataProviderPropertiesFromFile, getDefaultDataProviderProperties, getFilename, getLocations, getProviderPaths, getProvidersLocation, getRepresentationName, isLocal, scan

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IMAGE_DIR

public static final String IMAGE_DIR

See Also:

Constant Field Values

Constructor Detail

EuropeanaNewspapersResourceProvider

public EuropeanaNewspapersResourceProvider(String representationName,
                                   String mappingFile,
                                   String locations,
                                   String dataProviderId)
                                    throws IOException

Throws:

IOException

Method Detail

getResourceProviderId

public String getResourceProviderId(String path)

Description copied from interface: ResourceProvider

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

public String getDataProviderId(String path)

Description copied from interface: ResourceProvider

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

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

Description copied from interface: ResourceProvider

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

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

Description copied from interface: ResourceProvider

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

getFileCount

public int getFileCount(String localId)

Description copied from interface: ResourceProvider

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.

Specified by:

getFileCount in interface ResourceProvider

Overrides:

getFileCount in class DefaultResourceProvider

Parameters:

localId - local identifier of the record

Returns:

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

split

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

Description copied from interface: ResourceProvider

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.

Specified by:

split in interface ResourceProvider

Overrides:

split in class DefaultResourceProvider

Parameters:

paths - paths to files that will be migrated

Returns:

a list of lists

usePathsFile

public boolean usePathsFile()

Description copied from interface: ResourceProvider

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

Specified by:

usePathsFile in interface ResourceProvider

Overrides:

usePathsFile in class DefaultResourceProvider

Returns:

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

getReversedMapping

public Map<String,String> getReversedMapping()

Description copied from interface: ResourceProvider

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.

Specified by:

getReversedMapping in interface ResourceProvider

Overrides:

getReversedMapping in class DefaultResourceProvider

Returns:

reversed mapping