Package org.dspace.authority.orcid

Class Orcidv3AuthorityValue

java.lang.Object

org.dspace.authority.AuthorityValue

org.dspace.authority.PersonAuthorityValue

org.dspace.authority.orcid.Orcidv3AuthorityValue

public class Orcidv3AuthorityValue
extends PersonAuthorityValue

An AuthorityValue encapsulating information retrieved from ORCID

Author:

Jonas Van Goolen (jonas at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
static String	ORCID_ID_SYNTAX	The syntax that the ORCID id needs to conform to

Constructor Summary

Constructors

Constructor	Description
Orcidv3AuthorityValue()	Creates an instance of Orcidv3AuthorityValue with only uninitialized fields.
Orcidv3AuthorityValue(org.apache.solr.common.SolrDocument document)

Method Summary

Modifier and Type	Method	Description
void	addOtherMetadata(String label, String data)	Add additional metadata to the otherMetadata map
Map<String,String>	choiceSelectMap()	Information that can be used the choice ui
static Orcidv3AuthorityValue	create()	Create an empty authority.
static Orcidv3AuthorityValue	create(org.orcid.jaxb.model.v3.release.record.Person person)	Create an authority based on a given orcid bio
boolean	equals(Object o)
String	generateString()	Provides a string that will allow this AuthorityType to be recognized and provides information to create a new instance to be created using public Orcidv3AuthorityValue newInstance(String info).
String	getAuthorityType()
String	getOrcid_id()
Map<String,List<String>>	getOtherMetadata()
org.apache.solr.common.SolrInputDocument	getSolrInputDocument()	Generate a solr record from this instance
int	hashCode()
boolean	hasTheSameInformationAs(Object o)	The regular equals() only checks if both AuthorityValues describe the same authority.
boolean	isNewMetadata(String label, String data)	Check to see if the provided label / data pair is already present in the "otherMetadata" or not
AuthorityValue	newInstance(String info)	Makes an instance of the AuthorityValue with the given information.
void	setOrcid_id(String orcid_id)
void	setValue(String value)
void	setValues(org.apache.solr.common.SolrDocument document)	Initialize this instance based on a solr record
protected void	setValues(org.orcid.jaxb.model.v3.release.record.Person person)	Initialize this instance based on a Person object

Methods inherited from class org.dspace.authority.PersonAuthorityValue

addEmail, addNameVariant, getEmails, getFirstName, getInstitution, getLastName, getName, getNameVariants, setFirstName, setInstitution, setLastName, setName, toString

Methods inherited from class org.dspace.authority.AuthorityValue

delete, getCreationDate, getDateFormatters, getField, getId, getLastModified, getValue, isDeleted, setCreationDate, setCreationDate, setDeleted, setField, setId, setLastModified, setLastModified, stringToDate, update, updateItem, updateLastModifiedDate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ORCID_ID_SYNTAX

public static final String ORCID_ID_SYNTAX

The syntax that the ORCID id needs to conform to

See Also:

Constant Field Values

Constructor Detail

Orcidv3AuthorityValue

public Orcidv3AuthorityValue()

Creates an instance of Orcidv3AuthorityValue with only uninitialized fields. This is meant to be filled in with values from an existing record. To create a brand new Orcidv3AuthorityValue, use create()

Orcidv3AuthorityValue

public Orcidv3AuthorityValue(org.apache.solr.common.SolrDocument document)

Method Detail

getOrcid_id

public String getOrcid_id()

setOrcid_id

public void setOrcid_id(String orcid_id)

create

public static Orcidv3AuthorityValue create()

Create an empty authority.

Returns:

OrcidAuthorityValue

create

public static Orcidv3AuthorityValue create(org.orcid.jaxb.model.v3.release.record.Person person)

Create an authority based on a given orcid bio

Returns:

OrcidAuthorityValue

setValues

protected void setValues(org.orcid.jaxb.model.v3.release.record.Person person)

Initialize this instance based on a Person object

Parameters:

person - Person

newInstance

public AuthorityValue newInstance(String info)

Makes an instance of the AuthorityValue with the given information.

Overrides:

newInstance in class PersonAuthorityValue

Parameters:

info - string info

Returns:

AuthorityValue

setValue

public void setValue(String value)

Overrides:

setValue in class PersonAuthorityValue

isNewMetadata

public boolean isNewMetadata(String label,
                             String data)

Check to see if the provided label / data pair is already present in the "otherMetadata" or not

addOtherMetadata

public void addOtherMetadata(String label,
                             String data)

Add additional metadata to the otherMetadata map

getOtherMetadata

public Map<String,List<String>> getOtherMetadata()

getSolrInputDocument

public org.apache.solr.common.SolrInputDocument getSolrInputDocument()

Generate a solr record from this instance

Overrides:

getSolrInputDocument in class PersonAuthorityValue

Returns:

SolrInputDocument

choiceSelectMap

public Map<String,String> choiceSelectMap()

Information that can be used the choice ui

Overrides:

choiceSelectMap in class PersonAuthorityValue

Returns:

map

getAuthorityType

public String getAuthorityType()

Overrides:

getAuthorityType in class PersonAuthorityValue

generateString

public String generateString()

Provides a string that will allow this AuthorityType to be recognized and provides information to create a new instance to be created using public Orcidv3AuthorityValue newInstance(String info).

Overrides:

generateString in class PersonAuthorityValue

Returns:

see AuthorityValueService.GENERATE

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasTheSameInformationAs

public boolean hasTheSameInformationAs(Object o)

The regular equals() only checks if both AuthorityValues describe the same authority. This method checks if the AuthorityValues have different information E.g. it is used to decide when lastModified should be updated.

Overrides:

hasTheSameInformationAs in class PersonAuthorityValue

Parameters:

o - object

Returns:

true or false

setValues

public void setValues(org.apache.solr.common.SolrDocument document)

Description copied from class: AuthorityValue

Initialize this instance based on a solr record

Overrides:

setValues in class PersonAuthorityValue

Parameters:

document - SolrDocument