Package org.dspace.content.authority

Interface HierarchicalAuthority

All Superinterfaces:

ChoiceAuthority, NameAwarePlugin

All Known Implementing Classes:

DSpaceControlledVocabulary

public interface HierarchicalAuthority
extends ChoiceAuthority

Plugin interface that supplies an authority control mechanism for one metadata field.

Author:

Larry Stone

See Also:

ChoiceAuthority

Method Summary

Modifier and Type	Method	Description
Choices	getChoicesByParent(String authorityName, String parentId, int start, int limit, String locale)	Get all values from the authority that match the preferred value.
Choice	getParentChoice(String authorityName, String vocabularyId, String locale)	It returns the parent choice in the hierarchy if any
Integer	getPreloadLevel()	Provides an hint for the UI to preload some levels to improve the UX.
Choices	getTopChoices(String authorityName, int start, int limit, String locale)	Get all values from the authority that match the preferred value.
default boolean	isHierarchical()	Return true for hierarchical authorities

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

getBestMatch, getChoice, getExtra, getLabel, getMatches, getValue, isScrollable, storeAuthorityInMetadata

Methods inherited from interface org.dspace.core.NameAwarePlugin

getPluginInstanceName, setPluginInstanceName

Method Detail

getTopChoices

Choices getTopChoices(String authorityName,
                      int start,
                      int limit,
                      String locale)

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:

authorityName - authority name

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

getChoicesByParent

Choices getChoicesByParent(String authorityName,
                           String parentId,
                           int start,
                           int limit,
                           String locale)

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:

authorityName - authority name

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

getParentChoice

Choice getParentChoice(String authorityName,
                       String vocabularyId,
                       String locale)

It returns the parent choice in the hierarchy if any

Parameters:

authorityName - authority name

vocabularyId - user's value to match

locale - explicit localization key if available, or null

Returns:

a Choice object

getPreloadLevel

Integer getPreloadLevel()

Provides an hint for the UI to preload some levels to improve the UX. It usually mean that these preloaded level will be shown expanded by default

Specified by:

getPreloadLevel in interface ChoiceAuthority

Returns:

0 if hierarchical, null otherwise

isHierarchical

default boolean isHierarchical()

Description copied from interface: ChoiceAuthority

Return true for hierarchical authorities

Specified by:

isHierarchical in interface ChoiceAuthority

Returns:

true if hierarchical, default false