org.dspace.authority

Class AuthorityValue

java.lang.Object

org.dspace.authority.AuthorityValue

Direct Known Subclasses:

PersonAuthorityValue

public class AuthorityValue
extends 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)

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorityTypes	authorityTypes
protected MetadataValueService	metadataValueService

Constructor Summary

Constructors

Constructor and Description
AuthorityValue()
AuthorityValue(org.apache.solr.common.SolrDocument document)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	choiceSelectMap() Information that can be used the choice ui
void	delete()
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).
String	getAuthorityType()
Date	getCreationDate()
List<org.joda.time.format.DateTimeFormatter>	getDateFormatters()
String	getField()
String	getId()
Date	getLastModified()
org.apache.solr.common.SolrInputDocument	getSolrInputDocument() Generate a solr record from this instance
String	getValue()
boolean	hasTheSameInformationAs(Object o) The regular equals() only checks if both AuthorityValues describe the same authority.
boolean	isDeleted()
AuthorityValue	newInstance(String info) Makes an instance of the AuthorityValue with the given information.
void	setCreationDate(Date creationDate)
void	setCreationDate(String creationDate)
void	setDeleted(boolean deleted)
void	setField(String field)
void	setId(String id)
void	setLastModified(Date lastModified)
void	setLastModified(String lastModified)
void	setValue(String value)
void	setValues(org.apache.solr.common.SolrDocument document) Initialize this instance based on a solr record
Date	stringToDate(String date)
String	toString()
void	update()
void	updateItem(Context context, Item currentItem, MetadataValue 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

Field Detail

authorityTypes

@Autowired(required=true)
protected AuthorityTypes authorityTypes

metadataValueService

@Autowired(required=true)
protected MetadataValueService metadataValueService

Constructor Detail

AuthorityValue

public AuthorityValue()

AuthorityValue

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

Method Detail

getId

public String getId()

getField

public String getField()

getValue

public String getValue()

setId

public void setId(String id)

setField

public void setField(String field)

setValue

public void setValue(String value)

getCreationDate

public Date getCreationDate()

setCreationDate

public void setCreationDate(Date creationDate)

setCreationDate

public void setCreationDate(String creationDate)

getLastModified

public Date getLastModified()

setLastModified

public void setLastModified(String lastModified)

setLastModified

public void setLastModified(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

Returns:

SolrInputDocument

setValues

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

Initialize this instance based on a solr record

Parameters:

document - SolrDocument

updateItem

public void updateItem(Context context,
              Item currentItem,
              MetadataValue value)
                throws SQLException,
                       AuthorizeException

Replace an item's DCValue with this authority

Parameters:

context - context

value - metadata value

currentItem - item

Throws:

SQLException - if database error

AuthorizeException - if authorization error

choiceSelectMap

public Map<String,String> choiceSelectMap()

Information that can be used the choice ui

Returns:

map

getDateFormatters

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

stringToDate

public Date stringToDate(String date)

toString

public String toString()

Overrides:

toString in class Object

generateString

public 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.

Returns:

newInstance

public AuthorityValue newInstance(String info)

Makes an instance of the AuthorityValue with the given information.

Parameters:

info - string info

Returns:

AuthorityValue

getAuthorityType

public String getAuthorityType()

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.

Parameters:

o - object

Returns:

true or false