Package org.dspace.content.authority

Class SHERPARoMEOPublisher

java.lang.Object

org.dspace.content.authority.SHERPARoMEOPublisher

All Implemented Interfaces:

ChoiceAuthority, NameAwarePlugin

public class SHERPARoMEOPublisher
extends Object
implements ChoiceAuthority

Publisher name authority based on SHERPA/RoMEO v2

Version:

$Revision $

Author:

Larry Stone, Andrea Bollini (andrea.bollini at 4science.it)

See Also:

• SHERPARoMEOProtocol

Constructor Summary

Constructors

Constructor	Description
SHERPARoMEOPublisher()

Method Summary

Modifier and Type	Method	Description
Choices	getBestMatch(String text, String locale)	Get the single "best" match (if any) of a value in the authority to the given user value.
String	getLabel(String key, String locale)	Get the canonical user-visible "label" (i.e. short descriptive text) for a key in the authority.
Choices	getMatches(String text, int start, int limit, String locale)	Get all values from the authority that match the preferred value.
String	getPluginInstanceName()	Get the instance's particular name.
void	setPluginInstanceName(String name)	Set the name under which this plugin was instantiated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.content.authority.ChoiceAuthority

getChoice, getExtra, getPreloadLevel, getValue, isHierarchical, isScrollable, storeAuthorityInMetadata

Constructor Details

SHERPARoMEOPublisher

public SHERPARoMEOPublisher()

Method Details

getMatches

public Choices getMatches(String text,
 int start,
 int limit,
 String locale)

Description copied from interface: ChoiceAuthority

Get all values from the authority that match the preferred value. Note that the offering was entered by the user and may contain mixed/incorrect case, whitespace, etc so the plugin should be careful to clean up user data before making comparisons. Value of a "Name" field will be in canonical DSpace person name format, which is "Lastname, Firstname(s)", e.g. "Smith, John Q.". Some authorities with a small set of values may simply return the whole set for any sample value, although it's a good idea to set the defaultSelected index in the Choices instance to the choice, if any, that matches the value.

Specified by:

getMatches in interface ChoiceAuthority

Parameters:

text - user's value to match

start - choice at which to start, 0 is first.

limit - maximum number of choices to return, 0 for no limit.

locale - explicit localization key if available, or null

Returns:

a Choices object (never null).

getBestMatch

public Choices getBestMatch(String text,
 String locale)

Description copied from interface: ChoiceAuthority

Get the single "best" match (if any) of a value in the authority to the given user value. The "confidence" element of Choices is expected to be set to a meaningful value about the circumstances of this match. This call is typically used in non-interactive metadata ingest where there is no interactive agent to choose from among options.

Specified by:

getBestMatch in interface ChoiceAuthority

Parameters:

text - user's value to match

locale - explicit localization key if available, or null

Returns:

a Choices object (never null) with 1 or 0 values.

getLabel

public String getLabel(String key,
 String locale)

Description copied from interface: ChoiceAuthority

Get the canonical user-visible "label" (i.e. short descriptive text) for a key in the authority. Can be localized given the implicit or explicit locale specification. This may get called many times while populating a Web page so it should be implemented as efficiently as possible.

Specified by:

getLabel in interface ChoiceAuthority

Parameters:

key - authority key known to this authority.

locale - explicit localization key if available, or null

Returns:

descriptive label - should always return something, never null.

setPluginInstanceName

public void setPluginInstanceName(String name)

Description copied from interface: NameAwarePlugin

Set the name under which this plugin was instantiated. Not to be invoked by application code, it is called automatically by PluginService.getNamedPlugin() when the plugin is instantiated.

Specified by:

setPluginInstanceName in interface NameAwarePlugin

Parameters:

name - -- name used to select this class.

getPluginInstanceName

public String getPluginInstanceName()

Description copied from interface: NameAwarePlugin

Get the instance's particular name. Returns the name by which the class was chosen when this instance was created. Only works for instances created by PluginService, or if someone remembers to call setPluginName.

Useful when the implementation class wants to be configured differently when it is invoked under different names.

Specified by:

getPluginInstanceName in interface NameAwarePlugin

Returns:

name or null if not available.