Package org.dspace.curate

In DSpace, "curation" refers to the application of one or more "tasks" to one or more model objects. There are two fundamental classes to consider:

CurationTask

Code to be applied to model objects. A task is invoked on a single object, and may analyze and/or modify it as required.

Curator

Applies tasks to model objects as requested. See this class for details of the order of application of tasks to objects.

Curation requests may be run immediately or queued for batch processing. See TaskQueue and its relatives, Curation and its relatives for more on queued curation.

Tasks may also be attached to a workflow step, so that a set of tasks is applied to each uninstalled Item which passes through that step. See XmlWorkflowCuratorService.

A task may return to the Curator a status code, a final status message, and an optional report character stream.

The Reporter classes absorb strings of text and preserve it in various ways. A Reporter is a simple Appendable and makes no assumptions about e.g. whether a string represents a complete line. If you want your report formatted, insert appropriate newlines and other whitespace as needed. Your tasks can emit marked-up text if you wish, but the stock Reporter implementations make no attempt to render it.

Tasks may be annotated to inform the Curator of special properties. See Distributive, Mutative, Suspendable etc.

Interface Summary

Interface	Description
CurationTask	CurationTask describes a rather generic ability to perform an operation upon a DSpace object.
Reporter	A marker interface needed to make curation reporter classes into plugins.
ScriptedTask	ScriptedTask describes a rather generic ability to perform an operation upon a DSpace object.
TaskQueue	TaskQueue objects manage access to named queues of task entries.

Class Summary

Class	Description
AbstractCurationTask	AbstractCurationTask encapsulates a few common patterns of task use, resources, and convenience methods.
Curation	CurationCli provides command-line access to Curation tools and processes.
CurationCli	This is the CLI version of the Curation script.
CurationCliScriptConfiguration	This is the CLI version of the CurationScriptConfiguration class that handles the configuration for the CurationCli script
CurationScriptConfiguration<T extends Curation>	The ScriptConfiguration for the Curation script
Curator	Curator orchestrates and manages the application of a one or more curation tasks to a DSpace object.
FileReporter	Save a curation report to a unique file in the reports directory.
FileTaskQueue	FileTaskQueue provides a TaskQueue implementation based on flat files for the queues and semaphores.
LogReporter	Write curation report records through the logging framework.
ResolvedTask	ResolvedTask wraps an implementation of one of the CurationTask or ScriptedTask interfaces and provides for uniform invocation based on CurationTask methods.
TaskQueueEntry	TaskQueueEntry defines the record or entry in the named task queues.
TaskResolver	TaskResolver takes a logical name of a curation task and attempts to deliver a suitable implementation object.
Utils	Utils contains a few commonly occurring methods.
XmlWorkflowCuratorServiceImpl	Manage interactions between curation and workflow.

Enum Summary

Enum	Description
CurationClientOptions	This Enum holds all the possible options and combinations for the Curation script
Curator.Invoked	invocation modes - used by Suspendable tasks
Curator.TxScope

Annotation Types Summary

Annotation Type	Description
Distributive	Annotation type for CurationTasks.
Mutative	Annotation type for CurationTasks.
Suspendable	Annotation type for CurationTasks.