Package org.dspace.content.service

Interface MetadataFieldService

All Known Implementing Classes:

MetadataFieldServiceImpl

public interface MetadataFieldService

Service interface class for the MetadataField object. The implementation of this class is responsible for all business logic calls for the MetadataField object and is autowired by spring

Author:

kevinvandevelde at atmire.com

Method Summary

Modifier and Type	Method	Description
MetadataField	create(Context context, MetadataSchema metadataSchema, String element, String qualifier, String scopeNote)	Creates a new metadata field.
void	delete(Context context, MetadataField metadataField)	Delete the metadata field.
MetadataField	find(Context context, int id)	Find the field corresponding to the given numeric ID.
List<MetadataField>	findAll(Context context)	Retrieve all metadata field types from the registry
List<MetadataField>	findAllInSchema(Context context, MetadataSchema metadataSchema)	Return all metadata fields that are found in a given schema.
MetadataField	findByElement(Context context, String metadataSchemaName, String element, String qualifier)
MetadataField	findByElement(Context context, MetadataSchema metadataSchema, String element, String qualifier)	Retrieves the metadata field from the database.
MetadataField	findByString(Context context, String mdString, char separator)	Separates an mdString in schema, element and qualifier parts, separated by a given separator And returns it's matching metadataField if found
List<MetadataField>	findFieldsByElementNameUnqualified(Context context, String metadataSchema, String element)
void	update(Context context, MetadataField metadataField)	Update the metadata field in the database.

Method Detail

create

MetadataField create(Context context,
                     MetadataSchema metadataSchema,
                     String element,
                     String qualifier,
                     String scopeNote)
              throws AuthorizeException,
                     SQLException,
                     NonUniqueMetadataException

Creates a new metadata field.

Parameters:

context - DSpace context object

metadataSchema - schema

scopeNote - scope note

element - element

qualifier - qualifier

Returns:

new MetadataField

Throws:

AuthorizeException - if authorization error

SQLException - if database error

NonUniqueMetadataException - if an existing field with an identical element and qualifier is already present

find

MetadataField find(Context context,
                   int id)
            throws 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:

SQLException - if database error

findByElement

MetadataField findByElement(Context context,
                            MetadataSchema metadataSchema,
                            String element,
                            String qualifier)
                     throws SQLException

Retrieves the metadata field from the database.

Parameters:

context - dspace context

metadataSchema - schema

element - element name

qualifier - qualifier (may be ANY or null)

Returns:

recalled metadata field

Throws:

SQLException - if database error

findByElement

MetadataField findByElement(Context context,
                            String metadataSchemaName,
                            String element,
                            String qualifier)
                     throws SQLException

Throws:

SQLException

findByString

MetadataField findByString(Context context,
                           String mdString,
                           char separator)
                    throws SQLException

Separates an mdString in schema, element and qualifier parts, separated by a given separator And returns it's matching metadataField if found

Parameters:

context - dspace context

mdString - String being separated to find corresponding mdField (ex dc.contributor)

separator - Separator being used to separate the mdString

Returns:

Corresponding MetadataField if found

Throws:

SQLException

findFieldsByElementNameUnqualified

List<MetadataField> findFieldsByElementNameUnqualified(Context context,
                                                       String metadataSchema,
                                                       String element)
                                                throws SQLException

Throws:

SQLException

findAll

List<MetadataField> findAll(Context context)
                     throws SQLException

Retrieve all metadata field types from the registry

Parameters:

context - dspace context

Returns:

an array of all the Dublin Core types

Throws:

SQLException - if database error

findAllInSchema

List<MetadataField> findAllInSchema(Context context,
                                    MetadataSchema metadataSchema)
                             throws SQLException

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

Parameters:

context - dspace context

metadataSchema - the metadata schema for which we want all our metadata fields

Returns:

array of metadata fields

Throws:

SQLException - if database error

update

void update(Context context,
            MetadataField metadataField)
     throws SQLException,
            AuthorizeException,
            NonUniqueMetadataException,
            IOException

Update the metadata field in the database.

Parameters:

context - dspace context

metadataField - metadata field

Throws:

SQLException - if database error

AuthorizeException - if authorization error

NonUniqueMetadataException - if an existing field with an identical element and qualifier is already present

IOException - if IO error

delete

void delete(Context context,
            MetadataField metadataField)
     throws SQLException,
            AuthorizeException

Delete the metadata field.

Parameters:

context - dspace context

metadataField - metadata field

Throws:

SQLException - if database error

AuthorizeException - if authorization error