Package org.dspace.authority

Class PersonAuthorityValue

java.lang.Object

org.dspace.authority.AuthorityValue

org.dspace.authority.PersonAuthorityValue

Direct Known Subclasses:

Orcidv3AuthorityValue

public class PersonAuthorityValue
extends AuthorityValue

Author:

Antoine Snyers (antoine at atmire.com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Constructor Summary

Constructors

Constructor	Description
PersonAuthorityValue()
PersonAuthorityValue(org.apache.solr.common.SolrDocument document)

Method Summary

Modifier and Type	Method	Description
void	addEmail(String email)
void	addNameVariant(String name)
Map<String,String>	choiceSelectMap()	Information that can be used the choice ui.
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 AuthorityValue.newInstance(String).
String	getAuthorityType()	Get the type of authority which created this value.
List<String>	getEmails()
String	getFirstName()
String	getInstitution()
String	getLastName()
String	getName()
List<String>	getNameVariants()
org.apache.solr.common.SolrInputDocument	getSolrInputDocument()	Generate a solr record from this instance
boolean	hasTheSameInformationAs(Object o)	The regular equals() only checks if both AuthorityValues describe the same authority.
AuthorityValue	newInstance(String info)	Makes an instance of the AuthorityValue with the given information.
void	setFirstName(String firstName)
void	setInstitution(String institution)
void	setLastName(String lastName)
void	setName(String name)
void	setValue(String value)
void	setValues(org.apache.solr.common.SolrDocument document)	Initialize this instance based on a solr record
String	toString()

Methods inherited from class org.dspace.authority.AuthorityValue

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

Methods inherited from class java.lang.Object

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

Constructor Details

PersonAuthorityValue

public PersonAuthorityValue()

PersonAuthorityValue

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

Method Details

getName

public String getName()

setName

public void setName(String name)

setValue

public void setValue(String value)

Overrides:

setValue in class AuthorityValue

getFirstName

public String getFirstName()

setFirstName

public void setFirstName(String firstName)

getLastName

public String getLastName()

setLastName

public void setLastName(String lastName)

getNameVariants

public List<String> getNameVariants()

addNameVariant

public void addNameVariant(String name)

getInstitution

public String getInstitution()

setInstitution

public void setInstitution(String institution)

getEmails

public List<String> getEmails()

addEmail

public void addEmail(String email)

getSolrInputDocument

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

Description copied from class: AuthorityValue

Generate a solr record from this instance

Overrides:

getSolrInputDocument in class AuthorityValue

Returns:

SolrInputDocument

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 AuthorityValue

Parameters:

document - SolrDocument

choiceSelectMap

public Map<String,String> choiceSelectMap()

Description copied from class: AuthorityValue

Information that can be used the choice ui.

Overrides:

choiceSelectMap in class AuthorityValue

Returns:

map

getAuthorityType

public String getAuthorityType()

Description copied from class: AuthorityValue

Get the type of authority which created this value.

Overrides:

getAuthorityType in class AuthorityValue

Returns:

type name.

generateString

public String generateString()

Description copied from class: AuthorityValue

Provides a string that will allow this AuthorityType to be recognized and provides information to create a new instance to be created using AuthorityValue.newInstance(String). See the implementation of AuthorityValueServiceImpl.generateRaw(java.lang.String, java.lang.String, java.lang.String) for more details.

Overrides:

generateString in class AuthorityValue

Returns:

see AuthorityValueService.GENERATE

newInstance

public AuthorityValue newInstance(String info)

Description copied from class: AuthorityValue

Makes an instance of the AuthorityValue with the given information.

Overrides:

newInstance in class AuthorityValue

Parameters:

info - string info

Returns:

AuthorityValue

toString

public String toString()

Overrides:

toString in class AuthorityValue

hasTheSameInformationAs

public boolean hasTheSameInformationAs(Object o)

Description copied from class: AuthorityValue

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 AuthorityValue

Parameters:

o - object

Returns:

true or false