Package org.dspace.content.authority

Class Choice

java.lang.Object

org.dspace.content.authority.Choice

public class Choice
extends Object

Record class to hold the data describing one option, or choice, for an authority-controlled metadata value.

Author:

Larry Stone

See Also:

• Choices

Field Summary

Fields

Modifier and Type	Field	Description
String	authority	Authority key for this value
Map<String,String>	extras
String	label	Label to display for this value (e.g. to present in UI menu)
boolean	selectable	A boolean representing if choice entry value can selected (usually true).
String	value	The canonical text value to insert into MetadataValue's text field

Constructor Summary

Constructors

Constructor	Description
Choice()
Choice(String authority, String value, String label)	Minimal constructor for this data object.
Choice(String authority, String label, String value, boolean selectable)	Constructor for common need of Hierarchical authorities that want to explicitly set the selectable flag
Choice(String authority, String label, String value, Map<String,String> extras)	Constructor to quickly setup the data object for basic authorities.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

authority

public String authority

Authority key for this value

label

public String label

Label to display for this value (e.g. to present in UI menu)

value

public String value

The canonical text value to insert into MetadataValue's text field

selectable

public boolean selectable

A boolean representing if choice entry value can selected (usually true). Hierarchical authority can flag some choice as not selectable to force the use to choice a more detailed terms in the tree, such a leaf or a deeper branch

extras

public Map<String,String> extras

Constructor Details

Choice

public Choice()

Choice

public Choice(String authority,
 String value,
 String label)

Minimal constructor for this data object. It assumes an empty map of extras information and a selected choice

Parameters:

authority - the authority key

value - the text value to store in the metadata

label - the value to display to the user

Choice

public Choice(String authority,
 String label,
 String value,
 Map<String,String> extras)

Constructor to quickly setup the data object for basic authorities. The choice is assumed to be selectable.

Parameters:

authority - the authority key

value - the text value to store in the metadata

label - the value to display to the user

extras - a key value map of extra information related to this choice

Choice

public Choice(String authority,
 String label,
 String value,
 boolean selectable)

Constructor for common need of Hierarchical authorities that want to explicitly set the selectable flag

Parameters:

authority - the authority key

value - the text value to store in the metadata

label - the value to display to the user

selectable - true if the choice can be selected, false if the a more accurate choice should be preferred