org.dspace.ctask.general

Class RequiredMetadata

java.lang.Object

org.dspace.curate.AbstractCurationTask

org.dspace.ctask.general.RequiredMetadata

All Implemented Interfaces:

CurationTask

@Suspendable
public class RequiredMetadata
extends AbstractCurationTask

RequiredMetadata task compares item metadata with fields marked as required in input-forms.xml. The task succeeds if all required fields are present in the item metadata, otherwise it fails. Primarily a curation task demonstrator.

Author:

richardrodgers

Field Summary

Fields

Modifier and Type	Field and Description
protected DCInputsReader	reader
protected Map<String,List<String>>	reqMap

Fields inherited from class org.dspace.curate.AbstractCurationTask

communityService, configurationService, curator, handleService, itemService, taskId

Constructor Summary

Constructors

Constructor and Description
RequiredMetadata()

Method Summary

Modifier and Type	Method and Description
protected List<String>	getReqList(String handle)
void	init(Curator curator, String taskId) Initialize task - parameters inform the task of it's invoking curator.
int	perform(DSpaceObject dso) Perform the curation task upon passed DSO

Methods inherited from class org.dspace.curate.AbstractCurationTask

dereference, distribute, perform, performItem, performObject, report, setResult, taskArrayProperty, taskBooleanProperty, taskIntProperty, taskLongProperty, taskProperty

Methods inherited from class java.lang.Object

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

Field Detail

reader

protected DCInputsReader reader

reqMap

protected Map<String,List<String>> reqMap

Constructor Detail

RequiredMetadata

public RequiredMetadata()

Method Detail

init

public void init(Curator curator,
                 String taskId)
          throws IOException

Description copied from interface: CurationTask

Initialize task - parameters inform the task of it's invoking curator. Since the curator can provide services to the task, this represents curation DI.

Specified by:

init in interface CurationTask

Overrides:

init in class AbstractCurationTask

Parameters:

curator - the Curator controlling this task

taskId - identifier task should use in invoking services

Throws:

IOException - if error

perform

public int perform(DSpaceObject dso)
            throws IOException

Perform the curation task upon passed DSO

Specified by:

perform in interface CurationTask

Specified by:

perform in class AbstractCurationTask

Parameters:

dso - the DSpace object

Returns:

status code

Throws:

IOException - if IO error

getReqList

protected List<String> getReqList(String handle)
                           throws DCInputsReaderException

Throws:

DCInputsReaderException