org.dspace.authority

Class AuthorityValue

java.lang.Object

org.dspace.authority.AuthorityValue

Direct Known Subclasses:

PersonAuthorityValue

public class AuthorityValue
extends java.lang.Object

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 and Description
AuthorityValue()
AuthorityValue(org.apache.solr.common.SolrDocument document)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	choiceSelectMap() Information that can be used the choice ui
void	delete()
static AuthorityValue	fromSolr(org.apache.solr.common.SolrDocument solrDocument)
java.lang.String	generateString() Provides a string that will be allow a this AuthorityType to be recognized and provides information to create a new instance to be created using public AuthorityValue newInstance(String info).
java.lang.String	getAuthorityType()
static AuthorityTypes	getAuthorityTypes()
java.util.Date	getCreationDate()
java.util.List<org.joda.time.format.DateTimeFormatter>	getDateFormatters()
java.lang.String	getField()
java.lang.String	getId()
java.util.Date	getLastModified()
org.apache.solr.common.SolrInputDocument	getSolrInputDocument() Generate a solr record from this instance
java.lang.String	getValue()
boolean	hasTheSameInformationAs(java.lang.Object o) The regular equals() only checks if both AuthorityValues describe the same authority.
boolean	isDeleted()
AuthorityValue	newInstance(java.lang.String info) Makes an instance of the AuthorityValue with the given information.
void	setCreationDate(java.util.Date creationDate)
void	setCreationDate(java.lang.String creationDate)
void	setDeleted(boolean deleted)
void	setField(java.lang.String field)
void	setId(java.lang.String id)
void	setLastModified(java.util.Date lastModified)
void	setLastModified(java.lang.String lastModified)
void	setValue(java.lang.String value)
void	setValues(org.apache.solr.common.SolrDocument document) Initialize this instance based on a solr record
java.util.Date	stringToDate(java.lang.String date)
java.lang.String	toString()
void	update()
void	updateItem(Item currentItem, Metadatum value) Replace an item's DCValue with this authority
protected void	updateLastModifiedDate()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorityValue

public AuthorityValue()

AuthorityValue

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

Method Detail

getId

public java.lang.String getId()

getField

public java.lang.String getField()

getValue

public java.lang.String getValue()

setId

public void setId(java.lang.String id)

setField

public void setField(java.lang.String field)

setValue

public void setValue(java.lang.String value)

getCreationDate

public java.util.Date getCreationDate()

setCreationDate

public void setCreationDate(java.util.Date creationDate)

setCreationDate

public void setCreationDate(java.lang.String creationDate)

getLastModified

public java.util.Date getLastModified()

setLastModified

public void setLastModified(java.lang.String lastModified)

setLastModified

public void setLastModified(java.util.Date lastModified)

isDeleted

public boolean isDeleted()

setDeleted

public void setDeleted(boolean deleted)

updateLastModifiedDate

protected void updateLastModifiedDate()

update

public void update()

delete

public void delete()

getSolrInputDocument

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

Generate a solr record from this instance

setValues

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

Initialize this instance based on a solr record

updateItem

public void updateItem(Item currentItem,
              Metadatum value)

Replace an item's DCValue with this authority

choiceSelectMap

public java.util.Map<java.lang.String,java.lang.String> choiceSelectMap()

Information that can be used the choice ui

getDateFormatters

public java.util.List<org.joda.time.format.DateTimeFormatter> getDateFormatters()

stringToDate

public java.util.Date stringToDate(java.lang.String date)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

generateString

public java.lang.String generateString()

Provides a string that will be allow a this AuthorityType to be recognized and provides information to create a new instance to be created using public AuthorityValue newInstance(String info). See the implementation of com.atmire.org.dspace.authority.AuthorityValueGenerator#generateRaw(java.lang.String, java.lang.String) for more precisions.

newInstance

public AuthorityValue newInstance(java.lang.String info)

Makes an instance of the AuthorityValue with the given information.

getAuthorityType

public java.lang.String getAuthorityType()

getAuthorityTypes

public static AuthorityTypes getAuthorityTypes()

fromSolr

public static AuthorityValue fromSolr(org.apache.solr.common.SolrDocument solrDocument)

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.