org.dspace.content.authority
Class MetadataAuthorityManager

java.lang.Object
  org.dspace.content.authority.MetadataAuthorityManager

public class MetadataAuthorityManager
extends Object

Broker for metadata authority settings configured for each metadata field. Configuration keys, per metadata field (e.g. "dc.contributer.author") # is field authority controlled (i.e. store authority, confidence values)? authority.controlled. = true # is field required to have an authority value, or may it be empty? # default is false. authority.required. = 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:

ChoiceAuthorityManager, Choices

Method Summary

List<String>	getAuthorityMetadata() Return the list of metadata field with authority control.
static MetadataAuthorityManager	getManager()
int	getMinConfidence(String schema, String element, String qualifier) Give the minimal level of confidence required to consider valid an authority value for the given metadata.
boolean	isAuthorityControlled(String fieldKey) Predicate - is field authority-controlled?
boolean	isAuthorityControlled(String schema, String element, String qualifier) Predicate - is field authority-controlled?
boolean	isAuthorityRequired(String fieldKey) Predicate - is authority value required for field?
boolean	isAuthorityRequired(String schema, String element, String qualifier) Predicate - is authority value required for field?
static String	makeFieldKey(String schema, String element, String qualifier) 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

Method Detail

getManager

public static MetadataAuthorityManager getManager()

isAuthorityControlled

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

Predicate - is field authority-controlled?

isAuthorityControlled

public boolean isAuthorityControlled(String fieldKey)

Predicate - is field authority-controlled?

isAuthorityRequired

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

Predicate - is authority value required for field?

isAuthorityRequired

public boolean isAuthorityRequired(String fieldKey)

Predicate - is authority value required for field?

makeFieldKey

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

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.

getMinConfidence

public int getMinConfidence(String schema,
                            String element,
                            String qualifier)

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

Returns:

the minimal valid level of confidence for the given metadata

getAuthorityMetadata

public List<String> getAuthorityMetadata()

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

Returns:

the list of metadata field with authority control