org.dspace.content

Class MetadataValue

java.lang.Object

org.dspace.content.MetadataValue

public class MetadataValue
extends java.lang.Object

Database access class representing a Dublin Core metadata value. It represents a value of a given MetadataField on an Item. (The Item can have many values of the same field.) It contains element, qualifier, value and language. the field (which names the schema, element, and qualifier), language, and a value.

Author:

Martin Hald

See Also:

MetadataSchema, MetadataField

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	authority Authority key, if any
int	confidence Authority confidence value -- see Choices class for values
java.lang.String	language The language of the field, may be null
int	place The position of the record.
java.lang.String	value The value of the field

Constructor Summary

Constructors

Constructor and Description
MetadataValue() Default constructor.
MetadataValue(MetadataField field) Constructor to create a value for a given field.
MetadataValue(TableRow row) Construct the metadata object from the matching database row.

Method Summary

Methods

Modifier and Type	Method and Description
void	create(Context context) Creates a new metadata value.
void	delete(Context context) Delete the metadata field.
boolean	equals(java.lang.Object obj) Return true if other is the same MetadataValue as this object, false otherwise
static MetadataValue	find(Context context, int valueId) Retrieves the metadata value from the database.
static java.util.List<MetadataValue>	findByField(Context context, int fieldId) Retrieves the metadata values for a given field from the database.
java.lang.String	getAuthority() Get the metadata authority
int	getConfidence() Get the metadata confidence
int	getFieldId() Get the field ID the metadata value represents.
int	getItemId() Get the item ID.
java.lang.String	getLanguage() Get the language (e.g.
int	getPlace() Get the place ordering.
java.lang.String	getValue() Get the metadata value.
int	getValueId() Get the value ID.
int	hashCode()
void	setAuthority(java.lang.String value) Set the metadata authority
void	setConfidence(int value) Set the metadata confidence
void	setFieldId(int fieldId) Set the field ID that the metadata value represents.
void	setItemId(int itemId) Set the item ID.
void	setLanguage(java.lang.String language) Set the language (e.g.
void	setPlace(int place) Set the place ordering.
void	setValue(java.lang.String value) Set the metadata value
void	update(Context context) Update the metadata value in the database.

Methods inherited from class java.lang.Object

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

Field Detail

value

public java.lang.String value

The value of the field

language

public java.lang.String language

The language of the field, may be null

place

public int place

The position of the record.

authority

public java.lang.String authority

Authority key, if any

confidence

public int confidence

Authority confidence value -- see Choices class for values

Constructor Detail

MetadataValue

public MetadataValue(TableRow row)

Construct the metadata object from the matching database row.

Parameters:

row - database row to use for contents

MetadataValue

public MetadataValue()

Default constructor.

MetadataValue

public MetadataValue(MetadataField field)

Constructor to create a value for a given field.

Parameters:

field - initial value for field

Method Detail

getFieldId

public int getFieldId()

Get the field ID the metadata value represents.

Returns:

metadata field ID

setFieldId

public void setFieldId(int fieldId)

Set the field ID that the metadata value represents.

Parameters:

fieldId - new field ID

getItemId

public int getItemId()

Get the item ID.

Returns:

item ID

setItemId

public void setItemId(int itemId)

Set the item ID.

Parameters:

itemId - new item ID

getLanguage

public java.lang.String getLanguage()

Get the language (e.g. "en").

Returns:

language

setLanguage

public void setLanguage(java.lang.String language)

Set the language (e.g. "en").

Parameters:

language - new language

getPlace

public int getPlace()

Get the place ordering.

Returns:

place ordering

setPlace

public void setPlace(int place)

Set the place ordering.

Parameters:

place - new place (relative order in series of values)

getValueId

public int getValueId()

Get the value ID.

Returns:

value ID

getValue

public java.lang.String getValue()

Get the metadata value.

Returns:

metadata value

setValue

public void setValue(java.lang.String value)

Set the metadata value

Parameters:

value - new metadata value

getAuthority

public java.lang.String getAuthority()

Get the metadata authority

Returns:

metadata authority

setAuthority

public void setAuthority(java.lang.String value)

Set the metadata authority

Parameters:

value - new metadata authority

getConfidence

public int getConfidence()

Get the metadata confidence

Returns:

metadata confidence

setConfidence

public void setConfidence(int value)

Set the metadata confidence

Parameters:

value - new metadata confidence

create

public void create(Context context)
            throws java.sql.SQLException,
                   AuthorizeException

Creates a new metadata value.

Parameters:

context - DSpace context object

Throws:

java.sql.SQLException

AuthorizeException

find

public static MetadataValue find(Context context,
                 int valueId)
                          throws java.io.IOException,
                                 java.sql.SQLException,
                                 AuthorizeException

Retrieves the metadata value from the database.

Parameters:

context - dspace context

valueId - database key id of value

Returns:

recalled metadata value

Throws:

java.io.IOException

java.sql.SQLException

AuthorizeException

findByField

public static java.util.List<MetadataValue> findByField(Context context,
                                        int fieldId)
                                                 throws java.io.IOException,
                                                        java.sql.SQLException,
                                                        AuthorizeException

Retrieves the metadata values for a given field from the database.

Parameters:

context - dspace context

fieldId - field whose values to look for

Returns:

a collection of metadata values

Throws:

java.io.IOException

java.sql.SQLException

AuthorizeException

update

public void update(Context context)
            throws java.sql.SQLException,
                   AuthorizeException

Update the metadata value in the database.

Parameters:

context - dspace context

Throws:

java.sql.SQLException

AuthorizeException

delete

public void delete(Context context)
            throws java.sql.SQLException,
                   AuthorizeException

Delete the metadata field.

Parameters:

context - dspace context

Throws:

java.sql.SQLException

AuthorizeException

equals

public boolean equals(java.lang.Object obj)

Return true if other is the same MetadataValue as this object, false otherwise

Overrides:

equals in class java.lang.Object

Parameters:

obj - object to compare to

Returns:

true if object passed in represents the same MetadataValue as this object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object