Package org.dspace.importer.external.openaire.service

Class OpenAireImportMetadataSourceServiceImpl

java.lang.Object

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

org.dspace.importer.external.service.AbstractImportMetadataSourceService<org.jdom2.Element>

org.dspace.importer.external.openaire.service.OpenAireImportMetadataSourceServiceImpl

All Implemented Interfaces:

MetadataSource, QuerySource

public class OpenAireImportMetadataSourceServiceImpl
extends AbstractImportMetadataSourceService<org.jdom2.Element>
implements QuerySource

Implements a data source for querying OpenAIRE

Author:

Pasquale Cavallo (pasquale.cavallo at 4science dot it)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OpenAireImportMetadataSourceServiceImpl.CountByQueryCallable
class	OpenAireImportMetadataSourceServiceImpl.SearchByIdCallable
class	OpenAireImportMetadataSourceServiceImpl.SearchByQueryCallable

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationService	configurationService

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
OpenAireImportMetadataSourceServiceImpl()

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	getBaseAddress()	Return the baseAddress set to this object
String	getImportSource()	The string that identifies this import implementation.
String	getQueryParam()	Get the name of the query param for the rest call
ImportRecord	getRecord(String id)	The string that identifies this import implementation.
ImportRecord	getRecord(Query query)	The string that identifies this import implementation.
Collection<ImportRecord>	getRecords(String query, int start, int count)	Find the number of records matching a string query.
Collection<ImportRecord>	getRecords(Query query)	Find records based on a object query.
int	getRecordsCount(String query)	Find the number of records matching a query;
int	getRecordsCount(Query query)	Find the number of records matching a query;
void	init()	Initialize the class
void	setBaseAddress(String baseAddress)	Set the baseAddress to this object
void	setQueryParam(String queryParam)	Set the name of the query param, this correspond to the index used (title, author)

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

Field Details

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

Constructor Details

OpenAireImportMetadataSourceServiceImpl

public OpenAireImportMetadataSourceServiceImpl()

Method Details

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

getRecord

public ImportRecord getRecord(String id)
                       throws MetadataSourceException

The string that identifies this import implementation. Preferable a URI

Specified by:

getRecord in interface QuerySource

Parameters:

id - identifier for the record

Returns:

the identifying uri

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecord

public ImportRecord getRecord(Query query)
                       throws MetadataSourceException

The string that identifies this import implementation. Preferable a URI

Specified by:

getRecord in interface QuerySource

Parameters:

query - a query matching a single record

Returns:

the identifying uri

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecordsCount

public int getRecordsCount(String query)
                    throws MetadataSourceException

Find the number of records matching a query;

Specified by:

getRecordsCount in interface QuerySource

Parameters:

query - a query string to base the search on.

Returns:

the sum of the matching records over this import source

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecordsCount

public int getRecordsCount(Query query)
                    throws MetadataSourceException

Find the number of records matching a query;

Specified by:

getRecordsCount in interface QuerySource

Parameters:

query - a query object to base the search on.

Returns:

the sum of the matching records over this import source

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecords

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

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

Specified by:

getRecords in interface QuerySource

Parameters:

query - a query string to base the search on.

start - offset to start at

count - number of records to retrieve.

Returns:

a set of records. Fully transformed.

Throws:

MetadataSourceException - if the underlying methods throw any exception.

getRecords

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

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.

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.

setBaseAddress

public void setBaseAddress(String baseAddress)

Set the baseAddress to this object

Parameters:

baseAddress - The String object that represents the baseAddress of this object

getBaseAddress

public String getBaseAddress()

Return the baseAddress set to this object

Returns:

The String object that represents the baseAddress of this object

setQueryParam

public void setQueryParam(String queryParam)

Set the name of the query param, this correspond to the index used (title, author)

Parameters:

queryParam - on which index make the query

getQueryParam

public String getQueryParam()

Get the name of the query param for the rest call

Returns:

the name of the query param, i.e. the index (title, author) to use

init

public void init()
          throws Exception

Initialize the class

Specified by:

init in class AbstractRemoteMetadataSource

Throws:

Exception - on generic exception