Package org.dspace.content.authority

Class MetadataAuthorityServiceImpl

java.lang.Object

org.dspace.content.authority.MetadataAuthorityServiceImpl

All Implemented Interfaces:

MetadataAuthorityService

public class MetadataAuthorityServiceImpl
extends Object
implements MetadataAuthorityService

Broker for metadata authority settings configured for each metadata field. Configuration keys, per metadata field (e.g. "dc.contributor.author") # is field authority controlled (i.e. store authority, confidence values)? authority.controlled.<FIELD> = true # is field required to have an authority value, or may it be empty? # default is false. authority.required.<FIELD> = true | false # default value of minimum confidence level for ALL fields - must be # symbolic confidence level, see org.dspace.content.authority.Choices authority.minconfidence = uncertain # minimum confidence level for this field authority.minconfidence.SCHEMA.ELEMENT.QUALIFIER = SYMBOL e.g. authority.minconfidence.dc.contributor.author = accepted NOTE: There is *expected* to be a "choices" (see ChoiceAuthorityManager) configuration for each authority-controlled field.

Author:

Larry Stone

See Also:

ChoiceAuthorityServiceImpl, Choices

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationService	configurationService
protected Map<String,Boolean>	controlled
protected int	defaultMinConfidence	fallback default value unless authority.minconfidence = X is configured.
protected Map<String,Boolean>	isAuthorityRequired
protected MetadataFieldService	metadataFieldService
protected Map<String,Integer>	minConfidence	map of field key to answer of which is the min acceptable confidence value for a field with authority

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataAuthorityServiceImpl()

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
List<String>	getAuthorityMetadata()	Return the list of metadata field with authority control.
int	getMinConfidence(MetadataField metadataField)	Give the minimal level of confidence required to consider valid an authority value for the given metadata.
void	init()
boolean	isAuthorityControlled(String fieldKey)	Predicate - is field authority-controlled?
boolean	isAuthorityControlled(MetadataField metadataField)	Predicate - is field authority-controlled?
boolean	isAuthorityRequired(String fieldKey)	Predicate - is authority value required for field?
boolean	isAuthorityRequired(MetadataField metadataField)	Predicate - is authority value required for field?
String	makeFieldKey(String schema, String element, String qualifier)	Construct a single key from the tuple of schema/element/qualifier that describes a metadata field.
String	makeFieldKey(MetadataField metadataField)	Construct a single key from the tuple of schema/element/qualifier that describes a metadata field.

Methods inherited from class java.lang.Object

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

Field Detail

metadataFieldService

@Autowired(required=true)
protected MetadataFieldService metadataFieldService

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

controlled

protected Map<String,Boolean> controlled

isAuthorityRequired

protected Map<String,Boolean> isAuthorityRequired

minConfidence

protected Map<String,Integer> minConfidence

map of field key to answer of which is the min acceptable confidence value for a field with authority

defaultMinConfidence

protected int defaultMinConfidence

fallback default value unless authority.minconfidence = X is configured.

Constructor Detail

MetadataAuthorityServiceImpl

protected MetadataAuthorityServiceImpl()

Method Detail

init

public void init()

isAuthorityControlled

public boolean isAuthorityControlled(MetadataField metadataField)

Description copied from interface: MetadataAuthorityService

Predicate - is field authority-controlled?

Specified by:

isAuthorityControlled in interface MetadataAuthorityService

Parameters:

metadataField - metadata field

Returns:

true/false

isAuthorityControlled

public boolean isAuthorityControlled(String fieldKey)

Description copied from interface: MetadataAuthorityService

Predicate - is field authority-controlled?

Specified by:

isAuthorityControlled in interface MetadataAuthorityService

Parameters:

fieldKey - field key

Returns:

true/false

isAuthorityRequired

public boolean isAuthorityRequired(MetadataField metadataField)

Description copied from interface: MetadataAuthorityService

Predicate - is authority value required for field?

Specified by:

isAuthorityRequired in interface MetadataAuthorityService

Parameters:

metadataField - metadata field

Returns:

true/false

isAuthorityRequired

public boolean isAuthorityRequired(String fieldKey)

Description copied from interface: MetadataAuthorityService

Predicate - is authority value required for field?

Specified by:

isAuthorityRequired in interface MetadataAuthorityService

Parameters:

fieldKey - field key

Returns:

true/false

makeFieldKey

public String makeFieldKey(MetadataField metadataField)

Description copied from interface: MetadataAuthorityService

Construct a single key from the tuple of schema/element/qualifier that describes a metadata field. Punt to the function we use for submission UI input forms, for now.

Specified by:

makeFieldKey in interface MetadataAuthorityService

Parameters:

metadataField - metadata field

Returns:

field key

makeFieldKey

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

Description copied from interface: MetadataAuthorityService

Construct a single key from the tuple of schema/element/qualifier that describes a metadata field. Punt to the function we use for submission UI input forms, for now.

Specified by:

makeFieldKey in interface MetadataAuthorityService

Parameters:

schema - schema

element - element

qualifier - qualifier

Returns:

field key

getMinConfidence

public int getMinConfidence(MetadataField metadataField)

Give the minimal level of confidence required to consider valid an authority value for the given metadata.

Specified by:

getMinConfidence in interface MetadataAuthorityService

Parameters:

metadataField - metadata field

Returns:

the minimal valid level of confidence for the given metadata

getAuthorityMetadata

public List<String> getAuthorityMetadata()

Description copied from interface: MetadataAuthorityService

Return the list of metadata field with authority control. The strings are in the form schema.element[.qualifier]

Specified by:

getAuthorityMetadata in interface MetadataAuthorityService

Returns:

the list of metadata field with authority control

clearCache

public void clearCache()

Description copied from interface: MetadataAuthorityService

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

Specified by:

clearCache in interface MetadataAuthorityService