org.dspace.authority.orcid

Class Orcidv2

java.lang.Object

org.dspace.authority.orcid.Orcidv2

All Implemented Interfaces:

SolrAuthorityInterface

public class Orcidv2
extends Object
implements SolrAuthorityInterface

Author:

Jonas Van Goolen (jonas at atmire dot com) This class contains all methods for retrieving "Person" objects calling the ORCID (version 2) endpoints. Additionally, this can also create AuthorityValues based on these returned Person objects

Field Summary

Fields

Modifier and Type	Field and Description
RESTConnector	restConnector

Method Summary

Modifier and Type	Method and Description
org.orcid.jaxb.model.record_v2.Person	getBio(String id) Retrieve a Person object based on a given orcid identifier
void	init() Initialize the accessToken that is required for all subsequent calls to ORCID
List<AuthorityValue>	queryAuthorities(String text, int max) Makes an instance of the AuthorityValue with the given information.
AuthorityValue	queryAuthorityID(String id) Create an AuthorityValue from a Person retrieved using the given orcid identifier.
List<org.orcid.jaxb.model.record_v2.Person>	queryBio(String text, int max) Retrieve a list of Person objects.
List<org.orcid.jaxb.model.record_v2.Person>	queryBio(String text, int start, int rows) Retrieve a list of Person objects.

Methods inherited from class java.lang.Object

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

Field Detail

restConnector

public RESTConnector restConnector

Method Detail

init

public void init()
          throws IOException

Initialize the accessToken that is required for all subsequent calls to ORCID

Throws:

IOException

queryAuthorities

public List<AuthorityValue> queryAuthorities(String text,
                                             int max)

Makes an instance of the AuthorityValue with the given information.

Specified by:

queryAuthorities in interface SolrAuthorityInterface

Parameters:

text - search string

Returns:

List

queryAuthorityID

public AuthorityValue queryAuthorityID(String id)

Create an AuthorityValue from a Person retrieved using the given orcid identifier.

Specified by:

queryAuthorityID in interface SolrAuthorityInterface

Parameters:

id - orcid identifier

Returns:

AuthorityValue

getBio

public org.orcid.jaxb.model.record_v2.Person getBio(String id)

Retrieve a Person object based on a given orcid identifier

Parameters:

id - orcid identifier

Returns:

Person

queryBio

public List<org.orcid.jaxb.model.record_v2.Person> queryBio(String text,
                                                            int start,
                                                            int rows)

Retrieve a list of Person objects.

Parameters:

text - search string

start - offset to use

rows - how many rows to return

Returns:

List

queryBio

public List<org.orcid.jaxb.model.record_v2.Person> queryBio(String text,
                                                            int max)

Retrieve a list of Person objects.

Parameters:

text - search string

max - how many rows to return

Returns:

List