org.dspace.importer.external.service

Class ImportService

java.lang.Object

org.dspace.importer.external.service.ImportService

All Implemented Interfaces:

Destroyable

public class ImportService
extends Object
implements Destroyable

Main entry point for the import framework. Instead of calling the different importer implementations, the ImportService should be called instead. This class contains the same methods as the other implementations, but has an extra parameter URL. This URL should be the same identifier that is returned by the "getImportSource" method that is defined in the importer implementation you want to use.

Author:

Roeland Dillen (roeland at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ANY

Constructor Summary

Constructors

Constructor and Description
ImportService() Constructs an empty ImportService class object

Method Summary

Modifier and Type	Method and Description
void	destroy() Call destroy on all Destroyable MetadataSource objects set in this ImportService
Collection<ImportRecord>	findMatchingRecords(String uri, Item item) Finds records based on an item Delegates to one or more MetadataSource implementations based on the uri.
Collection<ImportRecord>	findMatchingRecords(String uri, Query query) Finds records based on query object.
protected Map<String,MetadataSource>	getImportSources() Retrieve the importSources set to this class.
Collection<String>	getImportUrls() Retrieve the importUrls that are set on the importSources .
int	getNbRecords(String uri, Query query) Find the number of records matching a query;
int	getNbRecords(String uri, String query) Find the number of records matching a string query;
ImportRecord	getRecord(String uri, Query query) Get a single record from the source.
ImportRecord	getRecord(String uri, String id) Get a single record from a source.
Collection<ImportRecord>	getRecords(String uri, Query query) Find the number of records matching a object query.
Collection<ImportRecord>	getRecords(String uri, String query, int start, int count) Find the number of records matching a string query.
protected Collection<MetadataSource>	matchingImports(String uri) Utility method to find what import implementations match the imports uri.
void	setImportSources(List<MetadataSource> importSources) Sets the importsources that will be used to delegate the retrieving and matching of records to

Methods inherited from class java.lang.Object

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

Field Detail

ANY

protected static final String ANY

See Also:

Constant Field Values

Constructor Detail

ImportService

public ImportService()

Constructs an empty ImportService class object

Method Detail

setImportSources

@Autowired(required=false)
public void setImportSources(List<MetadataSource> importSources)
                                                 throws MetadataSourceException

Sets the importsources that will be used to delegate the retrieving and matching of records to

Parameters:

importSources - A list of MetadataSource to set to this service

Throws:

MetadataSourceException

getImportSources

protected Map<String,MetadataSource> getImportSources()

Retrieve the importSources set to this class.

Returns:

An unmodifiableMap of importSources

matchingImports

protected Collection<MetadataSource> matchingImports(String uri)

Utility method to find what import implementations match the imports uri.

Parameters:

uri - the identifier of the import implementation or * for all

Returns:

matching MetadataSource implementations

findMatchingRecords

public Collection<ImportRecord> findMatchingRecords(String uri,
                                                    Item item)
                                             throws MetadataSourceException

Finds records based on an item Delegates to one or more MetadataSource implementations based on the uri. Results will be aggregated.

Parameters:

uri - the identifier of the import implementation or * for all

item - an item to base the search on

Returns:

a collection of import records. Only the identifier of the found records may be put in the record.

Throws:

MetadataSourceException - if the underlying imports throw any exception.

findMatchingRecords

public Collection<ImportRecord> findMatchingRecords(String uri,
                                                    Query query)
                                             throws MetadataSourceException

Finds records based on query object. Delegates to one or more MetadataSource implementations based on the uri. Results will be aggregated.

Parameters:

uri - the identifier of the import implementation or * for all

query - a query object to base the search on. The implementation decides how the query is interpreted.

Returns:

a collection of import records. Only the identifier of the found records may be put in the record.

Throws:

MetadataSourceException

getNbRecords

public int getNbRecords(String uri,
                        String query)
                 throws MetadataSourceException

Find the number of records matching a string query;

Parameters:

uri - the identifier of the import implementation or * for all

query - a query to base the search on

Returns:

the sum of the matching records over all import sources

Throws:

MetadataSourceException

getNbRecords

public int getNbRecords(String uri,
                        Query query)
                 throws MetadataSourceException

Find the number of records matching a query;

Parameters:

uri - the identifier of the import implementation or * for all

query - a query object to base the search on The implementation decides how the query is interpreted.

Returns:

the sum of the matching records over all import sources

Throws:

MetadataSourceException

getRecords

public Collection<ImportRecord> getRecords(String uri,
                                           String query,
                                           int start,
                                           int count)
                                    throws MetadataSourceException

Find the number of records matching a string query. Supports pagination

Parameters:

uri - the identifier of the import implementation or * for all

query - a query object to base the search on. The implementation decides how the query is interpreted.

start - offset to start at

count - number of records to retrieve.

Returns:

a set of records. Fully transformed.

Throws:

MetadataSourceException

getRecords

public Collection<ImportRecord> getRecords(String uri,
                                           Query query)
                                    throws MetadataSourceException

Find the number of records matching a object query.

Parameters:

uri - the identifier of the import implementation or * for all

query - a query object to base the search on. The implementation decides how the query is interpreted.

Returns:

a set of records. Fully transformed.

Throws:

MetadataSourceException

getRecord

public ImportRecord getRecord(String uri,
                              String id)
                       throws MetadataSourceException

Get a single record from a source. The first match will be returned

Parameters:

uri - uri the identifier of the import implementation or * for all

id - identifier for the record

Returns:

a matching record

Throws:

MetadataSourceException

getRecord

public ImportRecord getRecord(String uri,
                              Query query)
                       throws MetadataSourceException

Get a single record from the source. The first match will be returned

Parameters:

uri - uri the identifier of the import implementation or * for all

query - a query matching a single record

Returns:

a matching record

Throws:

MetadataSourceException

getImportUrls

public Collection<String> getImportUrls()

Retrieve the importUrls that are set on the importSources .

Returns:

a Collection of string, representing the configured importUrls

destroy

public void destroy()
             throws Exception

Call destroy on all Destroyable MetadataSource objects set in this ImportService

Specified by:

destroy in interface Destroyable

Throws:

Exception