org.dspace.content.authority

Class SHERPARoMEOPublisher

java.lang.Object

org.dspace.content.authority.SHERPARoMEOProtocol

org.dspace.content.authority.SHERPARoMEOPublisher

All Implemented Interfaces:

ChoiceAuthority

public class SHERPARoMEOPublisher
extends SHERPARoMEOProtocol

Sample Publisher name authority based on SHERPA/RoMEO WARNING: This is a very crude and incomplete implementation, done mainly as a proof-of-concept. Any site that actually wants to use it will probably have to refine it (and give patches back to dspace.org).

Version:

$Revision $

Author:

Larry Stone

See Also:

SHERPARoMEOProtocol

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTHORITY
protected static String	LABEL
protected static String	RESULT

Constructor Summary

Constructors

Constructor and Description
SHERPARoMEOPublisher()

Method Summary

Methods

Modifier and Type	Method and Description
Choices	getMatches(String text, Collection collection, int start, int limit, String locale)
Choices	getMatches(String field, String text, Collection collection, int start, int limit, String locale) Get all values from the authority that match the preferred value.

Methods inherited from class org.dspace.content.authority.SHERPARoMEOProtocol

getBestMatch, getLabel, query

Methods inherited from class java.lang.Object

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

Field Detail

RESULT

protected static final String RESULT

See Also:

Constant Field Values

LABEL

protected static final String LABEL

See Also:

Constant Field Values

AUTHORITY

protected static final String AUTHORITY

Constructor Detail

SHERPARoMEOPublisher

public SHERPARoMEOPublisher()

Method Detail

getMatches

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

Specified by:

getMatches in class SHERPARoMEOProtocol

getMatches

public Choices getMatches(String field,
                 String text,
                 Collection collection,
                 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.

Parameters:

field - being matched for

text - user's value to match

collection - database ID of Collection for context (owner of Item)

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