Package org.dspace.app.rest.converter

Class CollectionConverter

java.lang.Object

org.dspace.app.rest.converter.DSpaceObjectConverter<Collection,CollectionRest>

org.dspace.app.rest.converter.CollectionConverter

All Implemented Interfaces:

DSpaceConverter<Collection,CollectionRest>, IndexableObjectConverter<Collection,CollectionRest>

@Component
public class CollectionConverter
extends DSpaceObjectConverter<Collection,CollectionRest>
implements IndexableObjectConverter<Collection,CollectionRest>

This is the converter from/to the Collection in the DSpace API data model and the REST data model

Author:

Andrea Bollini (andrea.bollini at 4science.it)

Constructor Summary

Constructors

Constructor	Description
CollectionConverter()

Method Summary

Modifier and Type	Method	Description
CollectionRest	convert(Collection collection, Projection projection)	Convert a DSpace model object into its equivalent REST resource, applying a given projection.
Class<Collection>	getModelClass()	For what DSpace API model class does this converter convert?
protected CollectionRest	newInstance()
boolean	supportsModel(IndexableObject idxo)

Methods inherited from class org.dspace.app.rest.converter.DSpaceObjectConverter

getPermissionFilteredMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionConverter

public CollectionConverter()

Method Detail

convert

public CollectionRest convert(Collection collection,
                              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<Collection,CollectionRest>

Overrides:

convert in class DSpaceObjectConverter<Collection,CollectionRest>

Parameters:

collection - a DSpace API model object.

Returns:

a resource representing the model object.

newInstance

protected CollectionRest newInstance()

Specified by:

newInstance in class DSpaceObjectConverter<Collection,CollectionRest>

getModelClass

public Class<Collection> getModelClass()

Description copied from interface: DSpaceConverter

For what DSpace API model class does this converter convert?

Specified by:

getModelClass in interface DSpaceConverter<Collection,CollectionRest>

Returns:

Class of model objects represented.

supportsModel

public boolean supportsModel(IndexableObject idxo)

Specified by:

supportsModel in interface IndexableObjectConverter<Collection,CollectionRest>

Parameters:

idxo - the IndexableObject to check

Returns:

true if the actual converter implementation is able to manage the supplied IndexableObject