Package org.dspace.content

Class MetadataSchemaServiceImpl

java.lang.Object

org.dspace.content.MetadataSchemaServiceImpl

All Implemented Interfaces:

MetadataSchemaService

public class MetadataSchemaServiceImpl
extends Object
implements MetadataSchemaService

Service implementation for the MetadataSchema object. This class is responsible for all business logic calls for the MetadataSchema 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 MetadataFieldService	metadataFieldService
protected MetadataSchemaDAO	metadataSchemaDAO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataSchemaServiceImpl()

Method Summary

Modifier and Type	Method	Description
MetadataSchema	create(Context context, String name, String namespace)	Creates a new metadata schema in the database, using the name and namespace.
void	delete(Context context, MetadataSchema metadataSchema)	Delete the metadata schema.
MetadataSchema	find(Context context, int id)	Get the schema corresponding with this numeric ID.
MetadataSchema	find(Context context, String shortName)	Get the schema corresponding with this short name.
List<MetadataSchema>	findAll(Context context)	Return all metadata schemas.
MetadataSchema	findByNamespace(Context context, String namespace)	Get the schema object corresponding to this namespace URI.
protected boolean	uniqueNamespace(Context context, int metadataSchemaId, String namespace)	Return true if and only if the passed name appears within the allowed number of times in the current schema.
protected boolean	uniqueShortName(Context context, int metadataSchemaId, String name)	Return true if and only if the passed name is unique.
void	update(Context context, MetadataSchema metadataSchema)	Update the metadata schema in the database.

Methods inherited from class java.lang.Object

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

Field Detail

metadataFieldService

@Autowired
protected MetadataFieldService metadataFieldService

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

metadataSchemaDAO

@Autowired(required=true)
protected MetadataSchemaDAO metadataSchemaDAO

Constructor Detail

MetadataSchemaServiceImpl

protected MetadataSchemaServiceImpl()

Method Detail

create

public MetadataSchema create(Context context,
                             String name,
                             String namespace)
                      throws SQLException,
                             AuthorizeException,
                             NonUniqueMetadataException

Description copied from interface: MetadataSchemaService

Creates a new metadata schema in the database, using the name and namespace.

Specified by:

create in interface MetadataSchemaService

Parameters:

context - DSpace context object

name - name

namespace - namespace

Returns:

new MetadataSchema

Throws:

SQLException - if database error

AuthorizeException - if authorization error

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

findByNamespace

public MetadataSchema findByNamespace(Context context,
                                      String namespace)
                               throws SQLException

Description copied from interface: MetadataSchemaService

Get the schema object corresponding to this namespace URI.

Specified by:

findByNamespace in interface MetadataSchemaService

Parameters:

context - DSpace context

namespace - namespace URI to match

Returns:

metadata schema object or null if none found.

Throws:

SQLException - if database error

update

public void update(Context context,
                   MetadataSchema metadataSchema)
            throws SQLException,
                   AuthorizeException,
                   NonUniqueMetadataException

Description copied from interface: MetadataSchemaService

Update the metadata schema in the database.

Specified by:

update in interface MetadataSchemaService

Parameters:

context - DSpace context

metadataSchema - metadata schema

Throws:

SQLException - if database error

AuthorizeException - if authorization error

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

delete

public void delete(Context context,
                   MetadataSchema metadataSchema)
            throws SQLException,
                   AuthorizeException

Description copied from interface: MetadataSchemaService

Delete the metadata schema.

Specified by:

delete in interface MetadataSchemaService

Parameters:

context - DSpace context

metadataSchema - metadata schema

Throws:

SQLException - if database error

AuthorizeException - if authorization error

findAll

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

Description copied from interface: MetadataSchemaService

Return all metadata schemas.

Specified by:

findAll in interface MetadataSchemaService

Parameters:

context - DSpace context

Returns:

array of metadata schemas

Throws:

SQLException - if database error

find

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

Description copied from interface: MetadataSchemaService

Get the schema corresponding with this numeric ID. The ID is a database key internal to DSpace.

Specified by:

find in interface MetadataSchemaService

Parameters:

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

id - the schema ID

Returns:

the metadata schema object

Throws:

SQLException - if database error

find

public MetadataSchema find(Context context,
                           String shortName)
                    throws SQLException

Description copied from interface: MetadataSchemaService

Get the schema corresponding with this short name.

Specified by:

find in interface MetadataSchemaService

Parameters:

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

shortName - the short name for the schema

Returns:

the metadata schema object

Throws:

SQLException - if database error

uniqueNamespace

protected boolean uniqueNamespace(Context context,
                                  int metadataSchemaId,
                                  String namespace)
                           throws SQLException

Return true if and only if the passed name appears within the allowed number of times in the current schema.

Parameters:

context - DSpace context

metadataSchemaId - metadata schema id

namespace - namespace URI to match

Returns:

true of false

Throws:

SQLException - if database error

uniqueShortName

protected boolean uniqueShortName(Context context,
                                  int metadataSchemaId,
                                  String name)
                           throws SQLException

Return true if and only if the passed name is unique.

Parameters:

context - DSpace context

metadataSchemaId - metadata schema id

name - short name of schema

Returns:

true of false

Throws:

SQLException - if database error