Package org.dspace.importer.external.openalex.service

Class OpenAlexImportMetadataSourceServiceImpl

java.lang.Object

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

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

org.dspace.importer.external.openalex.service.OpenAlexImportMetadataSourceServiceImpl

All Implemented Interfaces:

OpenAlexImportMetadataSourceService, MetadataSource, QuerySource

public class OpenAlexImportMetadataSourceServiceImpl
extends AbstractImportMetadataSourceService<String>
implements OpenAlexImportMetadataSourceService

Implementation of OpenAlexImportMetadataSourceService that provides metadata import functionality from OpenAlex into DSpace. This class interacts with the OpenAlex API to fetch metadata records based on queries or identifiers. It uses LiveImportClient to perform HTTP requests and processes responses to extract metadata.

Author:

Adamo Fapohunda (adamo.fapohunda 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
OpenAlexImportMetadataSourceServiceImpl()

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	getImportSource()	Returns the source name of the metadata provider.
ImportRecord	getRecord(String id)	Retrieves a metadata record by its OpenAlex identifier.
ImportRecord	getRecord(Query query)	Retrieves a metadata record by its identifier.
Collection<ImportRecord>	getRecords(String query, int start, int count)	Retrieves a collection of metadata records based on a query with pagination.
Collection<ImportRecord>	getRecords(Query query)	Find records based on a object query.
int	getRecordsCount(String query)	Counts the number of metadata records matching a query.
int	getRecordsCount(Query query)	Counts the number of metadata records matching a query.
void	init()	Initializes the service by validating necessary configurations.
void	setUrl(String url)	Sets the base URL for OpenAlex API requests.

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 Details

OpenAlexImportMetadataSourceServiceImpl

public OpenAlexImportMetadataSourceServiceImpl()

Method Details

getImportSource

public String getImportSource()

Returns the source name of the metadata provider.

Specified by:

getImportSource in interface MetadataSource

Returns:

The string "openalex".

getRecord

public ImportRecord getRecord(String id)
                       throws MetadataSourceException

Retrieves a metadata record by its OpenAlex identifier.

Specified by:

getRecord in interface QuerySource

Parameters:

id - The identifier of the record to fetch.

Returns:

The corresponding ImportRecord or null if not found.

Throws:

MetadataSourceException - If the ID is null or an error occurs.

getRecordsCount

public int getRecordsCount(String query)
                    throws MetadataSourceException

Counts the number of metadata records matching a query.

Specified by:

getRecordsCount in interface QuerySource

Parameters:

query - a query string to base the search on.

Returns:

The number of matching records.

Throws:

MetadataSourceException - If the query is null or an error occurs.

getRecordsCount

public int getRecordsCount(Query query)
                    throws MetadataSourceException

Counts the number of metadata records matching a query.

Specified by:

getRecordsCount in interface QuerySource

Parameters:

query - a query object to base the search on.

Returns:

The number of matching records.

Throws:

MetadataSourceException - If the query is null or an error occurs.

getRecords

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

Retrieves a collection of metadata records based on a query with pagination.

Specified by:

getRecords in interface QuerySource

Parameters:

query - a query string to base the search on.

start - The starting index for pagination.

count - The maximum number of records to return.

Returns:

A collection of matching ImportRecord.

Throws:

MetadataSourceException - If the query is null or an error occurs.

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

Retrieves a metadata record by its identifier.

Specified by:

getRecord in interface QuerySource

Parameters:

query - a query object containing the identifier of the record to fetch.

Returns:

The corresponding ImportRecord or null if not found.

Throws:

MetadataSourceException - If the query is null or an error occurs.

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.

init

public void init()
          throws Exception

Initializes the service by validating necessary configurations.

Specified by:

init in class AbstractRemoteMetadataSource

Throws:

Exception - If required properties are not properly set.

setUrl

public void setUrl(String url)

Sets the base URL for OpenAlex API requests.

Parameters:

url - The OpenAlex API base URL.