Package org.dspace.app.rest.converter

Class MetadataConverter

java.lang.Object

org.dspace.app.rest.converter.MetadataConverter

All Implemented Interfaces:

DSpaceConverter<MetadataValueList,MetadataRest>

@Component
public class MetadataConverter
extends Object
implements DSpaceConverter<MetadataValueList,MetadataRest>

Converter to translate between lists of domain MetadataValues and MetadataRest representations.

Constructor Summary

Constructors

Constructor	Description
MetadataConverter()

Method Summary

Modifier and Type	Method	Description
<T extends DSpaceObject> void	addMetadata(Context context, T dso, MetadataRest metadataRest)	Add to a DSpace object's domain metadata values from a rest representation.
MetadataRest	convert(MetadataValueList metadataValues, Projection projection)	Convert a DSpace model object into its equivalent REST resource, applying a given projection.
Class<MetadataValueList>	getModelClass()	For what DSpace API model class does this converter convert?
<T extends DSpaceObject> void	mergeMetadata(Context context, T dso, MetadataRest metadataRest)	Merge into a DSpace object's domain metadata values from a rest representation.
<T extends DSpaceObject> void	setMetadata(Context context, T dso, MetadataRest metadataRest)	Sets a DSpace object's domain metadata values from a rest representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataConverter

public MetadataConverter()

Method Detail

convert

public MetadataRest convert(MetadataValueList metadataValues,
                            Projection projection)

Description copied from interface: DSpaceConverter

Convert a DSpace model object into its equivalent REST resource, applying a given projection.

Specified by:

convert in interface DSpaceConverter<MetadataValueList,MetadataRest>

Parameters:

metadataValues - a DSpace API model object.

Returns:

a resource representing the model object.

getModelClass

public Class<MetadataValueList> getModelClass()

Description copied from interface: DSpaceConverter

For what DSpace API model class does this converter convert?

Specified by:

getModelClass in interface DSpaceConverter<MetadataValueList,MetadataRest>

Returns:

Class of model objects represented.

setMetadata

public <T extends DSpaceObject> void setMetadata(Context context,
                                                 T dso,
                                                 MetadataRest metadataRest)
                                          throws SQLException,
                                                 AuthorizeException

Sets a DSpace object's domain metadata values from a rest representation. Any existing metadata value is deleted or overwritten.

Parameters:

context - the context to use.

dso - the DSpace object.

metadataRest - the rest representation of the new metadata.

Throws:

SQLException - if a database error occurs.

AuthorizeException - if an authorization error occurs.

addMetadata

public <T extends DSpaceObject> void addMetadata(Context context,
                                                 T dso,
                                                 MetadataRest metadataRest)
                                          throws SQLException,
                                                 AuthorizeException

Add to a DSpace object's domain metadata values from a rest representation. Any existing metadata value is preserved.

Parameters:

context - the context to use.

dso - the DSpace object.

metadataRest - the rest representation of the new metadata.

Throws:

SQLException - if a database error occurs.

AuthorizeException - if an authorization error occurs.

mergeMetadata

public <T extends DSpaceObject> void mergeMetadata(Context context,
                                                   T dso,
                                                   MetadataRest metadataRest)
                                            throws SQLException,
                                                   AuthorizeException

Merge into a DSpace object's domain metadata values from a rest representation. Any existing metadata value is preserved or overwritten with the new ones

Parameters:

context - the context to use.

dso - the DSpace object.

metadataRest - the rest representation of the new metadata.

Throws:

SQLException - if a database error occurs.

AuthorizeException - if an authorization error occurs.