Package org.dspace.external.provider.impl

Class OpenAIREFundingDataProvider

java.lang.Object

org.dspace.external.provider.AbstractExternalDataProvider

org.dspace.external.provider.impl.OpenAIREFundingDataProvider

All Implemented Interfaces:

ExternalDataProvider

public class OpenAIREFundingDataProvider
extends AbstractExternalDataProvider

This class is the implementation of the ExternalDataProvider interface that will deal with the OpenAIRE External Data lookup

Author:

paulo-graca

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAIREFundingDataProvider.ExternalDataObjectBuilder	OpenAIRE Funding External Data Builder Class

Field Summary

Fields

Modifier and Type	Field	Description
protected OpenAIRERestConnector	connector	Connector to handle token and requests
protected static int	LIMIT_DEFAULT	rows default limit
protected static String	PREFIX	GrantAgreement prefix
protected String	sourceIdentifier	Source identifier (defined in beans)

Constructor Summary

Constructors

Constructor	Description
OpenAIREFundingDataProvider()

Method Summary

Modifier and Type	Method	Description
OpenAIRERestConnector	getConnector()
Optional<ExternalDataObject>	getExternalDataObject(String id)	This method will take a String id as a parameter and it'll call the ExternalDataProvider's endpoint or data source to retrieve and build the ExternalDataObject
int	getNumberOfResults(String query)	Returns the total amount of results that this source can return for the given query
String	getSourceIdentifier()	This method will return the SourceIdentifier for the ExternalDataProvider that implements the interface
void	init()	required method
eu.openaire.jaxb.model.Response	searchByProjectURI(String projectURI)
List<ExternalDataObject>	searchExternalDataObjects(String query, int start, int limit)	This method will query the ExternalDataProvider's endpoint or data source to retrieve and build a list of ExternalDataObjects through a search with the given parameters
void	setConnector(OpenAIRERestConnector connector)	Generic setter for OpenAIRERestConnector
void	setSourceIdentifier(String sourceIdentifier)	Generic setter for the sourceIdentifier
boolean	supports(String source)	This method will return a boolean indicating whether this ExternalDataProvider can deal with the given source or not

Methods inherited from class org.dspace.external.provider.AbstractExternalDataProvider

getSupportedEntityTypes, setSupportedEntityTypes, supportsEntityType

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

protected static final String PREFIX

GrantAgreement prefix

See Also:

Constant Field Values

LIMIT_DEFAULT

protected static final int LIMIT_DEFAULT

rows default limit

See Also:

Constant Field Values

sourceIdentifier

protected String sourceIdentifier

Source identifier (defined in beans)

connector

protected OpenAIRERestConnector connector

Connector to handle token and requests

Constructor Detail

OpenAIREFundingDataProvider

public OpenAIREFundingDataProvider()

Method Detail

init

public void init()
          throws IOException

required method

Throws:

IOException

getSourceIdentifier

public String getSourceIdentifier()

Description copied from interface: ExternalDataProvider

This method will return the SourceIdentifier for the ExternalDataProvider that implements the interface

Returns:

The source identifier as a String

getExternalDataObject

public Optional<ExternalDataObject> getExternalDataObject(String id)

Description copied from interface: ExternalDataProvider

This method will take a String id as a parameter and it'll call the ExternalDataProvider's endpoint or data source to retrieve and build the ExternalDataObject

Parameters:

id - The id on which will be searched

Returns:

An Optional object of ExternalDataObject. This is to indicate that this object may be null. This ExternalDataObject will return all the data returned by the ExternalDataProvider

searchExternalDataObjects

public List<ExternalDataObject> searchExternalDataObjects(String query,
                                                          int start,
                                                          int limit)

Description copied from interface: ExternalDataProvider

This method will query the ExternalDataProvider's endpoint or data source to retrieve and build a list of ExternalDataObjects through a search with the given parameters

Parameters:

query - The query for the search

start - The start of the search

limit - The max amount of records to be returned by the search

Returns:

A list of ExternalDataObjects that were retrieved and built by this search

supports

public boolean supports(String source)

Description copied from interface: ExternalDataProvider

This method will return a boolean indicating whether this ExternalDataProvider can deal with the given source or not

Parameters:

source - The source on which the check needs to be done

Returns:

A boolean indicating whether this ExternalDataProvider can deal with this source or not

getNumberOfResults

public int getNumberOfResults(String query)

Description copied from interface: ExternalDataProvider

Returns the total amount of results that this source can return for the given query

Parameters:

query - The query to be search on and give the total amount of results

Returns:

The total amount of results that the source can return for the given query

setSourceIdentifier

@Autowired(required=true)
public void setSourceIdentifier(String sourceIdentifier)

Generic setter for the sourceIdentifier

Parameters:

sourceIdentifier - The sourceIdentifier to be set on this OpenAIREFunderDataProvider

getConnector

public OpenAIRERestConnector getConnector()

setConnector

@Autowired(required=true)
public void setConnector(OpenAIRERestConnector connector)

Generic setter for OpenAIRERestConnector

Parameters:

connector -

searchByProjectURI

public eu.openaire.jaxb.model.Response searchByProjectURI(String projectURI)

Parameters:

projectURI - from type info:eu-repo/grantAgreement/FCT/3599-PPCDT/82130/PT

Returns:

Response