org.dspace.authority.orcid

Class Orcidv2AuthorityValue

java.lang.Object

org.dspace.authority.AuthorityValue

org.dspace.authority.PersonAuthorityValue

org.dspace.authority.orcid.Orcidv2AuthorityValue

public class Orcidv2AuthorityValue
extends PersonAuthorityValue

Author:

Jonas Van Goolen (jonas at atmire dot com)

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addOtherMetadata(java.lang.String label, java.lang.String data) Add additional metadata to the otherMetadata map
java.util.Map<java.lang.String,java.lang.String>	choiceSelectMap() Information that can be used the choice ui
static Orcidv2AuthorityValue	create() Create an empty authority.
static Orcidv2AuthorityValue	create(org.orcid.jaxb.model.record_v2.Person person) Create an authority based on a given orcid bio
boolean	equals(java.lang.Object o)
java.lang.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 Orcidv2AuthorityValue newInstance(String info).
java.lang.String	getAuthorityType()
java.lang.String	getOrcid_id()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getOtherMetadata()
org.apache.solr.common.SolrInputDocument	getSolrInputDocument() Generate a solr record from this instance
int	hashCode()
boolean	hasTheSameInformationAs(java.lang.Object o) The regular equals() only checks if both AuthorityValues describe the same authority.
boolean	isNewMetadata(java.lang.String label, java.lang.String data) Check to see if the provided label / data pair is already present in the "otherMetadata" or not
AuthorityValue	newInstance(java.lang.String info) Makes an instance of the AuthorityValue with the given information.
void	setOrcid_id(java.lang.String orcid_id)
void	setValue(java.lang.String value)
protected void	setValues(org.orcid.jaxb.model.record_v2.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, setValues, toString

Methods inherited from class org.dspace.authority.AuthorityValue

delete, fromSolr, getAuthorityTypes, 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 java.lang.String ORCID_ID_SYNTAX

The syntax that the ORCID id needs to conform to

See Also:

Constant Field Values

Constructor Detail

Orcidv2AuthorityValue

public Orcidv2AuthorityValue()

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

Orcidv2AuthorityValue

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

Method Detail

getOrcid_id

public java.lang.String getOrcid_id()

setOrcid_id

public void setOrcid_id(java.lang.String orcid_id)

create

public static Orcidv2AuthorityValue create()

Create an empty authority.

Returns:

OrcidAuthorityValue

create

public static Orcidv2AuthorityValue create(org.orcid.jaxb.model.record_v2.Person person)

Create an authority based on a given orcid bio

Returns:

OrcidAuthorityValue

setValues

protected void setValues(org.orcid.jaxb.model.record_v2.Person person)

Initialize this instance based on a Person object

Parameters:

person - Person

newInstance

public AuthorityValue newInstance(java.lang.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(java.lang.String value)

Overrides:

setValue in class PersonAuthorityValue

isNewMetadata

public boolean isNewMetadata(java.lang.String label,
                    java.lang.String data)

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

addOtherMetadata

public void addOtherMetadata(java.lang.String label,
                    java.lang.String data)

Add additional metadata to the otherMetadata map

getOtherMetadata

public java.util.Map<java.lang.String,java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.String> choiceSelectMap()

Information that can be used the choice ui

Overrides:

choiceSelectMap in class PersonAuthorityValue

Returns:

map

getAuthorityType

public java.lang.String getAuthorityType()

Overrides:

getAuthorityType in class PersonAuthorityValue

generateString

public java.lang.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 Orcidv2AuthorityValue newInstance(String info).

Overrides:

generateString in class PersonAuthorityValue

Returns:

see AuthorityValueGenerator.GENERATE

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasTheSameInformationAs

public boolean hasTheSameInformationAs(java.lang.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