Package org.dspace.content.service

Interface MetadataDSpaceCsvExportService

All Known Implementing Classes:

MetadataDSpaceCsvExportServiceImpl

public interface MetadataDSpaceCsvExportService

This is the interface to be implemented by a Service that deals with the exporting of Metadata

Method Summary

Modifier and Type	Method	Description
DSpaceCSV	export(Context context, Iterator<Item> toExport, boolean exportAll, DSpaceRunnableHandler handler)	This method will export all the Items in the given toExport iterator to a DSpaceCSV
DSpaceCSV	export(Context context, Community community, boolean exportAll, DSpaceRunnableHandler handler)	This method will export all the Items within the given Community to a DSpaceCSV
int	getCsvExportLimit()
DSpaceCSV	handleExport(Context context, boolean exportAllItems, boolean exportAllMetadata, String identifier, DSpaceRunnableHandler dSpaceRunnableHandler)	This method will export DSpaceObject objects depending on the parameters it gets.

Method Details

handleExport

DSpaceCSV handleExport(Context context,
 boolean exportAllItems,
 boolean exportAllMetadata,
 String identifier,
 DSpaceRunnableHandler dSpaceRunnableHandler)
                throws Exception

This method will export DSpaceObject objects depending on the parameters it gets. It can export all the items in the repository, all the items in a community, all the items in a collection or a specific item. The latter three are specified by the handle parameter. The entire repository can be exported by defining the exportAllItems parameter as true

Parameters:

context - The relevant DSpace context

exportAllItems - A boolean indicating whether or not the entire repository should be exported

exportAllMetadata - Defines if all metadata should be exported or only the allowed ones

identifier - The handle or UUID for the DSpaceObject to be exported, can be a Community, Collection or Item

Returns:

A DSpaceCSV object containing the exported information

Throws:

Exception - If something goes wrong

export

DSpaceCSV export(Context context,
 Iterator<Item> toExport,
 boolean exportAll,
 DSpaceRunnableHandler handler)
          throws Exception

This method will export all the Items in the given toExport iterator to a DSpaceCSV

Parameters:

context - The relevant DSpace context

toExport - The iterator containing the items to export

exportAll - Defines if all metadata should be exported or only the allowed ones

Returns:

A DSpaceCSV object containing the exported information

Throws:

Exception - If something goes wrong

export

DSpaceCSV export(Context context,
 Community community,
 boolean exportAll,
 DSpaceRunnableHandler handler)
          throws Exception

This method will export all the Items within the given Community to a DSpaceCSV

Parameters:

context - The relevant DSpace context

community - The Community that contains the Items to be exported

exportAll - Defines if all metadata should be exported or only the allowed ones

Returns:

A DSpaceCSV object containing the exported information

Throws:

Exception - If something goes wrong

getCsvExportLimit

int getCsvExportLimit()