Package org.dspace.content

Class MetadataFieldServiceImpl

java.lang.Object

org.dspace.content.MetadataFieldServiceImpl

All Implemented Interfaces:

MetadataFieldService

public class MetadataFieldServiceImpl
extends Object
implements MetadataFieldService

Service implementation for the MetadataField object. This class is responsible for all business logic calls for the MetadataField object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected MetadataFieldDAO	metadataFieldDAO
protected MetadataSchemaService	metadataSchemaService
protected MetadataValueService	metadataValueService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataFieldServiceImpl()

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 metadataSchemaName, String element)
protected boolean	hasElement(Context context, int fieldId, MetadataSchema metadataSchema, String element, String qualifier)	A sanity check that ensures a given element and qualifier are unique within a given schema.
void	update(Context context, MetadataField metadataField)	Update the metadata field in the database.

Methods inherited from class java.lang.Object

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

Field Detail

metadataFieldDAO

@Autowired(required=true)
protected MetadataFieldDAO metadataFieldDAO

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

metadataValueService

@Autowired(required=true)
protected MetadataValueService metadataValueService

metadataSchemaService

@Autowired(required=true)
protected MetadataSchemaService metadataSchemaService

Constructor Detail

MetadataFieldServiceImpl

protected MetadataFieldServiceImpl()

Method Detail

create

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

Description copied from interface: MetadataFieldService

Creates a new metadata field.

Specified by:

create in interface MetadataFieldService

Parameters:

context - DSpace context object

metadataSchema - schema

element - element

qualifier - qualifier

scopeNote - scope note

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

public MetadataField find(Context context,
                          int id)
                   throws SQLException

Description copied from interface: MetadataFieldService

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

Specified by:

find in interface MetadataFieldService

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

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

Description copied from interface: MetadataFieldService

Retrieves the metadata field from the database.

Specified by:

findByElement in interface MetadataFieldService

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

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

Specified by:

findByElement in interface MetadataFieldService

Throws:

SQLException

findByString

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

Description copied from interface: MetadataFieldService

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

Specified by:

findByString in interface MetadataFieldService

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

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

Specified by:

findFieldsByElementNameUnqualified in interface MetadataFieldService

Throws:

SQLException

findAll

public List<MetadataField> findAll(Context context)
                            throws SQLException

Description copied from interface: MetadataFieldService

Retrieve all metadata field types from the registry

Specified by:

findAll in interface MetadataFieldService

Parameters:

context - dspace context

Returns:

an array of all the Dublin Core types

Throws:

SQLException - if database error

findAllInSchema

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

Description copied from interface: MetadataFieldService

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

Specified by:

findAllInSchema in interface MetadataFieldService

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

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

Description copied from interface: MetadataFieldService

Update the metadata field in the database.

Specified by:

update in interface MetadataFieldService

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

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

Description copied from interface: MetadataFieldService

Delete the metadata field.

Specified by:

delete in interface MetadataFieldService

Parameters:

context - dspace context

metadataField - metadata field

Throws:

SQLException - if database error

AuthorizeException - if authorization error

hasElement

protected boolean hasElement(Context context,
                             int fieldId,
                             MetadataSchema metadataSchema,
                             String element,
                             String qualifier)
                      throws SQLException

A sanity check that ensures a given element and qualifier are unique within a given schema. The check happens in code as we cannot use a database constraint.

Parameters:

context - dspace context

fieldId - field id

metadataSchema - metadataSchema

element - element

qualifier - qualifier

Returns:

true if unique

Throws:

SQLException - if database error