org.dspace.harvest

Class HarvestedCollection

java.lang.Object

org.dspace.harvest.HarvestedCollection

public class HarvestedCollection
extends java.lang.Object

Author:

Alexey Maslov

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_BUSY
static int	STATUS_OAI_ERROR
static int	STATUS_QUEUED
static int	STATUS_READY
static int	STATUS_UNKNOWN_ERROR
static int	TYPE_DMD
static int	TYPE_DMDREF
static int	TYPE_FULL
static int	TYPE_NONE

Method Summary

Methods

Modifier and Type	Method and Description
static HarvestedCollection	create(Context c, int collectionId) Create a new harvest instance row for a specified collection.
void	delete()
static void	exists(Context c)
static HarvestedCollection	find(Context c, int collectionId) Find the harvest settings corresponding to this collection
static java.util.List<java.lang.Integer>	findAll(Context c) Find all collections that are set up for harvesting return: list of collection id's
static java.util.List<java.lang.Integer>	findByStatus(Context c, int status) Find all collections with the specified status flag.
static java.lang.Integer	findNewestHarvest(Context c) Find the collection that was harvested most recently.
static java.lang.Integer	findOldestHarvest(Context c) Find the collection that was harvested the longest time ago.
static java.util.List<java.lang.Integer>	findReady(Context c) Find all collections that are ready for harvesting return: list of collection id's
int	getCollectionId()
java.util.Date	getHarvestDate()
java.lang.String	getHarvestMessage()
java.lang.String	getHarvestMetadataConfig()
java.util.Date	getHarvestStartTime()
int	getHarvestStatus()
int	getHarvestType()
java.lang.String	getOaiSetId()
java.lang.String	getOaiSource()
boolean	isHarvestable() Returns whether this harvest instance is actually harvestable, i.e.
static boolean	isHarvestable(Context c, int collectionId) Returns whether the specified collection is harvestable, i.e.
boolean	isReady()
static boolean	isReady(Context c, int collectionId) Returns whether the specified collection is ready for immediate harvest.
void	setHarvestMessage(java.lang.String message)
void	setHarvestMetadataConfig(java.lang.String mdConfigId)
void	setHarvestParams(int type, java.lang.String oaiSource, java.lang.String oaiSetId, java.lang.String mdConfigId) A function to set all harvesting-related parameters at once
void	setHarvestResult(java.util.Date date, java.lang.String message)
void	setHarvestStartTime(java.util.Date date)
void	setHarvestStatus(int status) Sets the current status of the collection.
void	setHarvestType(int type)
void	setOaiSetId(java.lang.String oaiSetId)
void	setOaiSource(java.lang.String oaiSource)
void	update()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NONE

public static final int TYPE_NONE

See Also:

Constant Field Values

TYPE_DMD

public static final int TYPE_DMD

See Also:

Constant Field Values

TYPE_DMDREF

public static final int TYPE_DMDREF

See Also:

Constant Field Values

TYPE_FULL

public static final int TYPE_FULL

See Also:

Constant Field Values

STATUS_READY

public static final int STATUS_READY

See Also:

Constant Field Values

STATUS_BUSY

public static final int STATUS_BUSY

See Also:

Constant Field Values

STATUS_QUEUED

public static final int STATUS_QUEUED

See Also:

Constant Field Values

STATUS_OAI_ERROR

public static final int STATUS_OAI_ERROR

See Also:

Constant Field Values

STATUS_UNKNOWN_ERROR

public static final int STATUS_UNKNOWN_ERROR

See Also:

Constant Field Values

Method Detail

exists

public static void exists(Context c)
                   throws java.sql.SQLException

Throws:

java.sql.SQLException

find

public static HarvestedCollection find(Context c,
                       int collectionId)
                                throws java.sql.SQLException

Find the harvest settings corresponding to this collection

Returns:

a HarvestInstance object corresponding to this collection's settings, null if not found.

Throws:

java.sql.SQLException

create

public static HarvestedCollection create(Context c,
                         int collectionId)
                                  throws java.sql.SQLException

Create a new harvest instance row for a specified collection.

Returns:

a new HarvestInstance object

Throws:

java.sql.SQLException

isHarvestable

public static boolean isHarvestable(Context c,
                    int collectionId)
                             throws java.sql.SQLException

Returns whether the specified collection is harvestable, i.e. whether its harvesting options are set up correctly. This is distinct from "ready", since this collection may be in process of being harvested.

Throws:

java.sql.SQLException

isHarvestable

public boolean isHarvestable()
                      throws java.sql.SQLException

Returns whether this harvest instance is actually harvestable, i.e. whether its settings options are set up correctly. This is distinct from "ready", since this collection may be in process of being harvested.

Throws:

java.sql.SQLException

isReady

public static boolean isReady(Context c,
              int collectionId)
                       throws java.sql.SQLException

Returns whether the specified collection is ready for immediate harvest.

Throws:

java.sql.SQLException

isReady

public boolean isReady()
                throws java.sql.SQLException

Throws:

java.sql.SQLException

findAll

public static java.util.List<java.lang.Integer> findAll(Context c)
                                                 throws java.sql.SQLException

Find all collections that are set up for harvesting return: list of collection id's

Throws:

java.sql.SQLException

findReady

public static java.util.List<java.lang.Integer> findReady(Context c)
                                                   throws java.sql.SQLException

Find all collections that are ready for harvesting return: list of collection id's

Throws:

java.sql.SQLException

findByStatus

public static java.util.List<java.lang.Integer> findByStatus(Context c,
                                             int status)
                                                      throws java.sql.SQLException

Find all collections with the specified status flag.

Parameters:

c -

status - see HarvestInstance.STATUS_...

Throws:

java.sql.SQLException

findOldestHarvest

public static java.lang.Integer findOldestHarvest(Context c)
                                           throws java.sql.SQLException

Find the collection that was harvested the longest time ago.

Throws:

java.sql.SQLException

findNewestHarvest

public static java.lang.Integer findNewestHarvest(Context c)
                                           throws java.sql.SQLException

Find the collection that was harvested most recently.

Throws:

java.sql.SQLException

setHarvestParams

public void setHarvestParams(int type,
                    java.lang.String oaiSource,
                    java.lang.String oaiSetId,
                    java.lang.String mdConfigId)

A function to set all harvesting-related parameters at once

setHarvestType

public void setHarvestType(int type)

setHarvestStatus

public void setHarvestStatus(int status)

Sets the current status of the collection.

Parameters:

status - a HarvestInstance.STATUS_... constant

setOaiSource

public void setOaiSource(java.lang.String oaiSource)

setOaiSetId

public void setOaiSetId(java.lang.String oaiSetId)

setHarvestMetadataConfig

public void setHarvestMetadataConfig(java.lang.String mdConfigId)

setHarvestResult

public void setHarvestResult(java.util.Date date,
                    java.lang.String message)

setHarvestMessage

public void setHarvestMessage(java.lang.String message)

setHarvestStartTime

public void setHarvestStartTime(java.util.Date date)

getCollectionId

public int getCollectionId()

getHarvestType

public int getHarvestType()

getHarvestStatus

public int getHarvestStatus()

getOaiSource

public java.lang.String getOaiSource()

getOaiSetId

public java.lang.String getOaiSetId()

getHarvestMetadataConfig

public java.lang.String getHarvestMetadataConfig()

getHarvestMessage

public java.lang.String getHarvestMessage()

getHarvestDate

public java.util.Date getHarvestDate()

getHarvestStartTime

public java.util.Date getHarvestStartTime()

delete

public void delete()
            throws java.sql.SQLException

Throws:

java.sql.SQLException

update

public void update()
            throws java.sql.SQLException,
                   java.io.IOException,
                   AuthorizeException

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException