org.dspace.content

Class MetadataField

java.lang.Object

org.dspace.content.MetadataField

public class MetadataField
extends java.lang.Object

DSpace object that represents a metadata field, which is defined by a combination of schema, element, and qualifier. Every metadata element belongs in a field.

Version:

$Revision$

Author:

Martin Hald

See Also:

MetadataValue, MetadataSchema

Constructor Summary

Constructors

Constructor and Description
MetadataField() Default constructor.
MetadataField(int schemaID, int fieldID, java.lang.String element, java.lang.String qualifier, java.lang.String scopeNote) Full constructor for existing metadata field elements.
MetadataField(MetadataSchema schema) Constructor creating a field within a schema.
MetadataField(MetadataSchema schema, java.lang.String element, java.lang.String qualifier, java.lang.String scopeNote) Full constructor for new metadata field elements.
MetadataField(TableRow row) Constructor to load the object from the database.

Method Summary

Methods

Modifier and Type	Method and Description
void	create(Context context) Creates a new metadata field.
void	delete(Context context) Delete the metadata field.
boolean	equals(java.lang.Object obj) Return true if other is the same MetadataField as this object, false otherwise
static MetadataField	find(Context context, int id) Find the field corresponding to the given numeric ID.
static MetadataField[]	findAll(Context context) Retrieve all Dublin Core types from the registry
static MetadataField[]	findAllInSchema(Context context, int schemaID) Return all metadata fields that are found in a given schema.
static MetadataField	findByElement(Context context, int schemaID, java.lang.String element, java.lang.String qualifier) Retrieves the metadata field from the database.
static java.lang.String	formKey(java.lang.String schema, java.lang.String element, java.lang.String qualifier) Return the HTML FORM key for the given field.
java.lang.String	getElement() Get the element name.
int	getFieldID() Get the metadata field id.
java.lang.String	getQualifier() Get the qualifier.
int	getSchemaID() Get the schema record key.
java.lang.String	getScopeNote() Get the scope note.
int	hashCode()
void	setElement(java.lang.String element) Set the element name.
void	setQualifier(java.lang.String qualifier) Set the qualifier.
void	setSchemaID(int schemaID) Set the schema record key.
void	setScopeNote(java.lang.String scopeNote) Set the scope note.
void	update(Context context) Update the metadata field in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataField

public MetadataField()

Default constructor.

MetadataField

public MetadataField(MetadataSchema schema)

Constructor creating a field within a schema.

Parameters:

schema - schema to which the field belongs

MetadataField

public MetadataField(MetadataSchema schema,
             java.lang.String element,
             java.lang.String qualifier,
             java.lang.String scopeNote)

Full constructor for new metadata field elements.

Parameters:

schema - schema to which the field belongs

element - element of the field

qualifier - qualifier of the field

scopeNote - scope note of the field

MetadataField

public MetadataField(int schemaID,
             int fieldID,
             java.lang.String element,
             java.lang.String qualifier,
             java.lang.String scopeNote)

Full constructor for existing metadata field elements.

Parameters:

schemaID - schema to which the field belongs

fieldID - database ID of field.

element - element of the field

qualifier - qualifier of the field

scopeNote - scope note of the field

MetadataField

public MetadataField(TableRow row)

Constructor to load the object from the database.

Parameters:

row - database row from which to populate object.

Method Detail

getElement

public java.lang.String getElement()

Get the element name.

Returns:

element name

setElement

public void setElement(java.lang.String element)

Set the element name.

Parameters:

element - new value for element

getFieldID

public int getFieldID()

Get the metadata field id.

Returns:

metadata field id

getQualifier

public java.lang.String getQualifier()

Get the qualifier.

Returns:

qualifier

setQualifier

public void setQualifier(java.lang.String qualifier)

Set the qualifier.

Parameters:

qualifier - new value for qualifier

getSchemaID

public int getSchemaID()

Get the schema record key.

Returns:

schema record key

setSchemaID

public void setSchemaID(int schemaID)

Set the schema record key.

Parameters:

schemaID - new value for key

getScopeNote

public java.lang.String getScopeNote()

Get the scope note.

Returns:

scope note

setScopeNote

public void setScopeNote(java.lang.String scopeNote)

Set the scope note.

Parameters:

scopeNote - new value for scope note

create

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

Creates a new metadata field.

Parameters:

context - DSpace context object

Throws:

java.io.IOException

AuthorizeException

java.sql.SQLException

NonUniqueMetadataException

findByElement

public static MetadataField findByElement(Context context,
                          int schemaID,
                          java.lang.String element,
                          java.lang.String qualifier)
                                   throws java.sql.SQLException,
                                          AuthorizeException

Retrieves the metadata field from the database.

Parameters:

context - dspace context

schemaID - schema by ID

element - element name

qualifier - qualifier (may be ANY or null)

Returns:

recalled metadata field

Throws:

java.sql.SQLException

AuthorizeException

findAll

public static MetadataField[] findAll(Context context)
                               throws java.sql.SQLException

Retrieve all Dublin Core types from the registry

Parameters:

context - dspace context

Returns:

an array of all the Dublin Core types

Throws:

java.sql.SQLException

findAllInSchema

public static MetadataField[] findAllInSchema(Context context,
                              int schemaID)
                                       throws java.sql.SQLException

Return all metadata fields that are found in a given schema.

Parameters:

context - dspace context

schemaID - schema by db ID

Returns:

array of metadata fields

Throws:

java.sql.SQLException

update

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

Update the metadata field in the database.

Parameters:

context - dspace context

Throws:

java.sql.SQLException

AuthorizeException

NonUniqueMetadataException

java.io.IOException

delete

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

Delete the metadata field.

Parameters:

context - dspace context

Throws:

java.sql.SQLException

AuthorizeException

formKey

public static java.lang.String formKey(java.lang.String schema,
                       java.lang.String element,
                       java.lang.String qualifier)

Return the HTML FORM key for the given field.

Parameters:

schema -

element -

qualifier -

Returns:

HTML FORM key

find

public static MetadataField find(Context context,
                 int id)
                          throws java.sql.SQLException

Find the field corresponding to the given numeric ID. The ID is a database key internal to DSpace.

Parameters:

context - context, in case we need to read it in from DB

id - the metadata field ID

Returns:

the metadata field object

Throws:

java.sql.SQLException

equals

public boolean equals(java.lang.Object obj)

Return true if other is the same MetadataField 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 MetadataField as this object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object