Package org.dspace.app.rest.utils

Class AuthorityUtils

java.lang.Object

org.dspace.app.rest.utils.AuthorityUtils

@Component
public class AuthorityUtils
extends Object

Utility methods to expose the authority framework over REST

Author:

Andrea Bollini (andrea.bollini at 4science.it)

Field Summary

Fields

Modifier and Type	Field	Description
static String	PRESENTATION_TYPE_AUTHORLOOKUP
static String	PRESENTATION_TYPE_LOOKUP
static String	PRESENTATION_TYPE_SUGGEST
static String	RESERVED_KEYMAP_PARENT

Constructor Summary

Constructors

Constructor	Description
AuthorityUtils()

Method Summary

Modifier and Type	Method	Description
VocabularyRest	convertAuthority(org.dspace.content.authority.ChoiceAuthority source, String authorityName, Projection projection)	TODO the authorityName MUST be a part of ChoiceAuthority model
VocabularyEntryRest	convertEntry(org.dspace.content.authority.Choice choice, String authorityName, boolean storeAuthority, Projection projection)	This utility method is currently a workaround to enrich the REST object with information from the parent vocabulary that is not referenced by the Choice model
VocabularyEntryDetailsRest	convertEntryDetails(org.dspace.content.authority.Choice choice, String authorityName, boolean isHierarchical, Projection projection)	TODO the authorityName MUST be a part of Choice model
String	getAuthorityName(String schema, String element, String qualifier)
String	getPresentation(String schema, String element, String qualifier)
boolean	isChoice(String schema, String element, String qualifier)
boolean	isClosed(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

PRESENTATION_TYPE_LOOKUP

public static final String PRESENTATION_TYPE_LOOKUP

See Also:

Constant Field Values

PRESENTATION_TYPE_AUTHORLOOKUP

public static final String PRESENTATION_TYPE_AUTHORLOOKUP

See Also:

Constant Field Values

PRESENTATION_TYPE_SUGGEST

public static final String PRESENTATION_TYPE_SUGGEST

See Also:

Constant Field Values

RESERVED_KEYMAP_PARENT

public static final String RESERVED_KEYMAP_PARENT

See Also:

Constant Field Values

Constructor Detail

AuthorityUtils

public AuthorityUtils()

Method Detail

isChoice

public boolean isChoice(String schema,
                        String element,
                        String qualifier)

getAuthorityName

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

isClosed

public boolean isClosed(String schema,
                        String element,
                        String qualifier)

getPresentation

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

convertEntryDetails

public VocabularyEntryDetailsRest convertEntryDetails(org.dspace.content.authority.Choice choice,
                                                      String authorityName,
                                                      boolean isHierarchical,
                                                      Projection projection)

TODO the authorityName MUST be a part of Choice model

Parameters:

choice -

authorityName -

projection - the name of the projection to use, or null.

Returns:

convertEntry

public VocabularyEntryRest convertEntry(org.dspace.content.authority.Choice choice,
                                        String authorityName,
                                        boolean storeAuthority,
                                        Projection projection)

This utility method is currently a workaround to enrich the REST object with information from the parent vocabulary that is not referenced by the Choice model

Parameters:

choice - the dspace-api choice to expose as vocabulary entry

authorityName - the name of the vocabulary

storeAuthority - true if the entry id should be exposed as an authority for storing it in the metadatavalue

projection - the rest projection to apply

Returns:

the vocabulary entry rest reppresentation of the provided choice

convertAuthority

public VocabularyRest convertAuthority(org.dspace.content.authority.ChoiceAuthority source,
                                       String authorityName,
                                       Projection projection)

TODO the authorityName MUST be a part of ChoiceAuthority model

Parameters:

source -

authorityName -

projection - the projecton to use.

Returns: