Package org.dspace.content.authority

Class ChoiceAuthorityServiceImpl

java.lang.Object

org.dspace.content.authority.ChoiceAuthorityServiceImpl

All Implemented Interfaces:

ChoiceAuthorityService

public final class ChoiceAuthorityServiceImpl
extends Object
implements ChoiceAuthorityService

Broker for ChoiceAuthority plugins, and for other information configured about the choice aspect of authority control for a metadata field. Configuration keys, per metadata field (e.g. "dc.contributer.author") # names the ChoiceAuthority plugin called for this field choices.plugin.<FIELD> = name-of-plugin # mode of UI presentation desired in submission UI: # "select" is dropdown menu, "lookup" is popup with selector, "suggest" is autocomplete/suggest choices.presentation.<FIELD> = "select" | "suggest" # is value "closed" to the set of these choices or are non-authority values permitted? choices.closed.<FIELD> = true | false

Author:

Larry Stone

See Also:

ChoiceAuthority

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	authorities
protected Map<String,Boolean>	closed
protected ConfigurationService	configurationService
protected Map<String,ChoiceAuthority>	controller
protected PluginService	pluginService
protected Map<String,String>	presentation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChoiceAuthorityServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	clearCache()	This method has been created to have a way of clearing the cache kept inside the service
protected String	config2fkey(String field)
Choices	getBestMatch(String fieldKey, String query, Collection collection, String locale)	Wrapper that calls getBestMatch method of the plugin corresponding to the metadata field defined by single field key.
Choice	getChoice(String fieldKey, String authKey, String locale)
Set<String>	getChoiceAuthoritiesNames()
ChoiceAuthority	getChoiceAuthorityByAuthorityName(String authorityName)
String	getChoiceAuthorityName(String schema, String element, String qualifier)
String	getChoiceMetadatabyAuthorityName(String name)
String	getLabel(String fieldKey, String authKey, String locale)	Wrapper that calls getLabel method of the plugin corresponding to the metadata field defined by single field key.
String	getLabel(MetadataValue metadataValue, String locale)	Wrapper that calls getLabel method of the plugin corresponding to the metadata field defined by schema,element,qualifier.
Choices	getMatches(String schema, String element, String qualifier, String query, Collection collection, int start, int limit, String locale)	Wrapper that calls getMatches method of the plugin corresponding to the metadata field defined by schema,element,qualifier.
Choices	getMatches(String fieldKey, String query, Collection collection, int start, int limit, String locale)	Wrapper calls getMatches method of the plugin corresponding to the metadata field defined by single field key.
Choices	getMatches(String fieldKey, String query, Collection collection, int start, int limit, String locale, boolean externalInput)
String	getPresentation(String fieldKey)	Get the presentation keyword (should be "lookup", "select" or "suggest", but this is an informal convention so it can be easily extended) for this field.
List<String>	getVariants(MetadataValue metadataValue)	Wrapper to call plugin's getVariants().
boolean	isChoicesConfigured(String fieldKey)	Predicate, is there a Choices configuration of any kind for the given metadata field?
boolean	isClosed(String fieldKey)	Get the configured "closed" value for this field.
protected String	makeFieldKey(String schema, String element, String qualifier)

Methods inherited from class java.lang.Object

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

Field Detail

controller

protected Map<String,ChoiceAuthority> controller

presentation

protected Map<String,String> presentation

closed

protected Map<String,Boolean> closed

authorities

protected Map<String,String> authorities

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

pluginService

@Autowired(required=true)
protected PluginService pluginService

Constructor Detail

ChoiceAuthorityServiceImpl

protected ChoiceAuthorityServiceImpl()

Method Detail

config2fkey

protected String config2fkey(String field)

getChoiceAuthoritiesNames

public Set<String> getChoiceAuthoritiesNames()

Specified by:

getChoiceAuthoritiesNames in interface ChoiceAuthorityService

Returns:

the names of all the defined choice authorities

getMatches

public Choices getMatches(String schema,
                          String element,
                          String qualifier,
                          String query,
                          Collection collection,
                          int start,
                          int limit,
                          String locale)

Description copied from interface: ChoiceAuthorityService

Wrapper that calls getMatches method of the plugin corresponding to the metadata field defined by schema,element,qualifier.

Specified by:

getMatches in interface ChoiceAuthorityService

Parameters:

schema - schema of metadata field

element - element of metadata field

qualifier - qualifier of metadata field

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

See Also:

ChoiceAuthority.getMatches(java.lang.String, java.lang.String, org.dspace .content.Collection, int, int, java.lang.String)

getMatches

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

Description copied from interface: ChoiceAuthorityService

Wrapper calls getMatches method of the plugin corresponding to the metadata field defined by single field key.

Specified by:

getMatches in interface ChoiceAuthorityService

Parameters:

fieldKey - single string identifying metadata field

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

See Also:

ChoiceAuthority.getMatches(java.lang.String, java.lang.String, org.dspace .content.Collection, int, int, java.lang.String)

getMatches

public Choices getMatches(String fieldKey,
                          String query,
                          Collection collection,
                          int start,
                          int limit,
                          String locale,
                          boolean externalInput)

Specified by:

getMatches in interface ChoiceAuthorityService

getBestMatch

public Choices getBestMatch(String fieldKey,
                            String query,
                            Collection collection,
                            String locale)

Description copied from interface: ChoiceAuthorityService

Wrapper that calls getBestMatch method of the plugin corresponding to the metadata field defined by single field key.

Specified by:

getBestMatch in interface ChoiceAuthorityService

Parameters:

fieldKey - single string identifying metadata field

query - user's value to match

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

locale - explicit localization key if available, or null

Returns:

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

See Also:

ChoiceAuthority.getBestMatch(java.lang.String, java.lang.String, org.dspace .content.Collection, java.lang.String)

getLabel

public String getLabel(MetadataValue metadataValue,
                       String locale)

Description copied from interface: ChoiceAuthorityService

Wrapper that calls getLabel method of the plugin corresponding to the metadata field defined by schema,element,qualifier.

Specified by:

getLabel in interface ChoiceAuthorityService

Parameters:

metadataValue - metadata value

locale - explicit localization key if available

Returns:

label

getLabel

public String getLabel(String fieldKey,
                       String authKey,
                       String locale)

Description copied from interface: ChoiceAuthorityService

Wrapper that calls getLabel method of the plugin corresponding to the metadata field defined by single field key.

Specified by:

getLabel in interface ChoiceAuthorityService

Parameters:

fieldKey - single string identifying metadata field

authKey - authority key

locale - explicit localization key if available

Returns:

label

isChoicesConfigured

public boolean isChoicesConfigured(String fieldKey)

Description copied from interface: ChoiceAuthorityService

Predicate, is there a Choices configuration of any kind for the given metadata field?

Specified by:

isChoicesConfigured in interface ChoiceAuthorityService

Parameters:

fieldKey - single string identifying metadata field

Returns:

true if choices are configured for this field.

getPresentation

public String getPresentation(String fieldKey)

Description copied from interface: ChoiceAuthorityService

Get the presentation keyword (should be "lookup", "select" or "suggest", but this is an informal convention so it can be easily extended) for this field.

Specified by:

getPresentation in interface ChoiceAuthorityService

Parameters:

fieldKey - field key

Returns:

configured presentation type for this field, or null if none found

isClosed

public boolean isClosed(String fieldKey)

Description copied from interface: ChoiceAuthorityService

Get the configured "closed" value for this field.

Specified by:

isClosed in interface ChoiceAuthorityService

Parameters:

fieldKey - single string identifying metadata field

Returns:

true if choices are closed for this field.

getVariants

public List<String> getVariants(MetadataValue metadataValue)

Description copied from interface: ChoiceAuthorityService

Wrapper to call plugin's getVariants().

Specified by:

getVariants in interface ChoiceAuthorityService

Parameters:

metadataValue - metadata value

Returns:

List of variants

getChoiceAuthorityName

public String getChoiceAuthorityName(String schema,
                                     String element,
                                     String qualifier)

Specified by:

getChoiceAuthorityName in interface ChoiceAuthorityService

Parameters:

schema - schema of metadata field

element - element of metadata field

qualifier - qualifier of metadata field

Returns:

the name of the choice authority associated with the specified metadata. Throw IllegalArgumentException if the supplied metadat is not associated with an authority choice

makeFieldKey

protected String makeFieldKey(String schema,
                              String element,
                              String qualifier)

clearCache

public void clearCache()

Description copied from interface: ChoiceAuthorityService

This method has been created to have a way of clearing the cache kept inside the service

Specified by:

clearCache in interface ChoiceAuthorityService

getChoiceMetadatabyAuthorityName

public String getChoiceMetadatabyAuthorityName(String name)

Specified by:

getChoiceMetadatabyAuthorityName in interface ChoiceAuthorityService

getChoice

public Choice getChoice(String fieldKey,
                        String authKey,
                        String locale)

Specified by:

getChoice in interface ChoiceAuthorityService

getChoiceAuthorityByAuthorityName

public ChoiceAuthority getChoiceAuthorityByAuthorityName(String authorityName)

Specified by:

getChoiceAuthorityByAuthorityName in interface ChoiceAuthorityService