org.dspace.curate

Class CitationPage

java.lang.Object

org.dspace.curate.AbstractCurationTask

org.dspace.curate.CitationPage

All Implemented Interfaces:

CurationTask

@Distributive
@Mutative
public class CitationPage
extends AbstractCurationTask

CitationPage This task is used to generate a cover page with citation information for text documents and then to add that cover page to a PDF version of the document replacing the originally uploaded document form the user's perspective.

Author:

Ryan McGowan

Field Summary

Fields inherited from class org.dspace.curate.AbstractCurationTask

curator, taskId

Constructor Summary

Constructors

Constructor and Description
CitationPage()

Method Summary

Methods

Modifier and Type	Method and Description
int	perform(DSpaceObject dso) Perform the curation task upon passed DSO
protected void	performItem(Item item) Performs task upon a single DSpace Item.

Methods inherited from class org.dspace.curate.AbstractCurationTask

dereference, distribute, init, perform, performObject, report, setResult, taskBooleanProperty, taskIntProperty, taskLongProperty, taskProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

CitationPage

public CitationPage()

Method Detail

perform

public int perform(DSpaceObject dso)
            throws java.io.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:

java.io.IOException

See Also:

CurationTask.perform(DSpaceObject)

performItem

protected void performItem(Item item)
                    throws java.sql.SQLException

Performs task upon a single DSpace Item. Used in conjunction with the distribute method to run a single task across multiple Items.

You should override this method if you want to use distribute to run your task across multiple DSpace Items.

Either this method or performObject should be overridden if distribute method is used.

Overrides:

performItem in class AbstractCurationTask

Parameters:

item - the DSpace Item

Throws:

java.sql.SQLException

See Also:

AbstractCurationTask.performItem(Item)