eu.dnetlib.data.download.rmi

Interface DownloadPlugin

public interface DownloadPlugin

The DownloadPluin should retrieve the correct URL of the file to download

Method Summary

Modifier and Type	Method and Description
String	getPluginName() Get the name of the plugin
List<String>	getRegularExpression() Gets the regular expression.
DownloadItem	retrieveUrl(DownloadItem item) This method retrieve the correct Url of the file from the starting URL
Iterable<DownloadItem>	retrieveUrls(Iterable<DownloadItem> items) This method retrieve the correct Url of the file from a list of starting URL
void	setBasePath(String basePath) If Sets the base path, the plugin will start to download from the basePath in the file system
void	setRegularExpression(List<String> regularExpression) Sets the regular expression.

Method Detail

setBasePath

void setBasePath(String basePath)

If Sets the base path, the plugin will start to download from the basePath in the file system

Parameters:

basePath - the base path

retrieveUrl

DownloadItem retrieveUrl(DownloadItem item)
                  throws DownloadPluginException

This method retrieve the correct Url of the file from the starting URL

Parameters:

item - the starting url

Returns:

the Url of the correct file

Throws:

DownloadPluginException

retrieveUrls

Iterable<DownloadItem> retrieveUrls(Iterable<DownloadItem> items)
                             throws DownloadPluginException

This method retrieve the correct Url of the file from a list of starting URL

Parameters:

items - the list of starting url

Returns:

the list of the file URL

Throws:

DownloadPluginException

getPluginName

String getPluginName()

Get the name of the plugin

Returns:

the name of the plugin

getRegularExpression

List<String> getRegularExpression()

Gets the regular expression.

Returns:

the regular expression

setRegularExpression

void setRegularExpression(List<String> regularExpression)

Sets the regular expression.

Parameters:

regularExpression - the new regular expression