Package org.dspace.importer.external.crossref

Class CrossRefImportMetadataSourceServiceImpl

java.lang.Object

org.dspace.importer.external.service.components.AbstractRemoteMetadataSource

org.dspace.importer.external.service.AbstractImportMetadataSourceService<String>

org.dspace.importer.external.crossref.CrossRefImportMetadataSourceServiceImpl

All Implemented Interfaces:

MetadataSource, QuerySource

public class CrossRefImportMetadataSourceServiceImpl
extends AbstractImportMetadataSourceService<String>
implements QuerySource

Implements a data source for querying CrossRef

Author:

Mykhaylo Boychuk (mykhaylo.boychuk at 4science.com)

Field Summary

Fields inherited from class org.dspace.importer.external.service.components.AbstractRemoteMetadataSource

error, exceptionHandlersMap, interRequestTime, lastRequest, lock, maxRetry, operationId, retry, warning

Constructor Summary

Constructors

Constructor	Description
CrossRefImportMetadataSourceServiceImpl()

Method Summary

Modifier and Type	Method	Description
Collection<ImportRecord>	findMatchingRecords(Item item)	Finds records based on an item Delegates to one or more MetadataSource implementations based on the uri.
Collection<ImportRecord>	findMatchingRecords(Query query)	Finds records based on query object.
String	getID(String id)
String	getImportSource()	The string that identifies this import implementation.
ImportRecord	getRecord(String recordId)	Get a single record from the source.
ImportRecord	getRecord(Query query)	Get a single record from the source.
Collection<ImportRecord>	getRecords(String query, int start, int count)	Gets a set of records matching a query.
Collection<ImportRecord>	getRecords(Query query)	Find records based on a object query.
int	getRecordsCount(String query)	Gets the number of records matching a query
int	getRecordsCount(Query query)	Gets the number of records matching a query
void	init()	Attempts to init a session
void	setUrl(String url)

Methods inherited from class org.dspace.importer.external.service.AbstractImportMetadataSourceService

getGenerateQueryForItem, getMetadataFieldMapping, setGenerateQueryForItem, setMetadataFieldMapping, transformSourceRecords

Methods inherited from class org.dspace.importer.external.service.components.AbstractRemoteMetadataSource

getError, getExceptionHandler, getMaxRetry, getOperationId, getRetry, getWarning, handleException, initExceptionHandlers, retry, setError, setInterRequestTime, setMaxRetry, setWarning, throwSourceException, throwSourceExceptionHook

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossRefImportMetadataSourceServiceImpl

public CrossRefImportMetadataSourceServiceImpl()

Method Detail

getImportSource

public String getImportSource()

Description copied from interface: MetadataSource

The string that identifies this import implementation. Preferable a URI

Specified by:

getImportSource in interface MetadataSource

Returns:

the identifying uri

init

public void init()
          throws Exception

Description copied from class: AbstractRemoteMetadataSource

Attempts to init a session

Specified by:

init in class AbstractRemoteMetadataSource

Throws:

Exception - on generic exception

getRecord

public ImportRecord getRecord(String recordId)
                       throws MetadataSourceException

Description copied from interface: QuerySource

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

Specified by:

getRecord in interface QuerySource

Parameters:

recordId - identifier for the record

Returns:

a matching record

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecordsCount

public int getRecordsCount(String query)
                    throws MetadataSourceException

Description copied from interface: QuerySource

Gets the number of records matching a query

Specified by:

getRecordsCount in interface QuerySource

Parameters:

query - the query in string format

Returns:

the number of records matching the query

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecordsCount

public int getRecordsCount(Query query)
                    throws MetadataSourceException

Description copied from interface: QuerySource

Gets the number of records matching a query

Specified by:

getRecordsCount in interface QuerySource

Parameters:

query - the query object

Returns:

the number of records matching the query

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecords

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

Description copied from interface: QuerySource

Gets a set of records matching a query. Supports pagination

Specified by:

getRecords in interface QuerySource

Parameters:

query - the query. The query will generally be posted 'as is' to the source

start - offset

count - page size

Returns:

a collection of fully transformed id's

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecords

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

Description copied from interface: QuerySource

Find records based on a object query.

Specified by:

getRecords in interface QuerySource

Parameters:

query - a query object to base the search on.

Returns:

a set of records. Fully transformed.

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecord

public ImportRecord getRecord(Query query)
                       throws MetadataSourceException

Description copied from interface: QuerySource

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

Specified by:

getRecord in interface QuerySource

Parameters:

query - a query matching a single record

Returns:

a matching record

Throws:

MetadataSourceException - if the underlying methods throw any exception.

findMatchingRecords

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

Description copied from interface: QuerySource

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

Specified by:

findMatchingRecords in interface QuerySource

Parameters:

query - a query object 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 - passed through.

findMatchingRecords

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

Description copied from interface: QuerySource

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

Specified by:

findMatchingRecords in interface QuerySource

Parameters:

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 methods throw any exception.

getID

public String getID(String id)

setUrl

public void setUrl(String url)