org.dspace.search

Class Harvest

java.lang.Object

org.dspace.search.Harvest

public class Harvest
extends java.lang.Object

Utility class for extracting information about items, possibly just within a certain community or collection, that have been created, modified or withdrawn within a particular range of dates.

Version:

$Revision$

Author:

Robert Tansley

Constructor Summary

Constructors

Constructor and Description
Harvest()

Method Summary

Methods

Modifier and Type	Method and Description
static HarvestedItemInfo	getSingle(Context context, java.lang.String handle, boolean collections) Get harvested item info for a single item.
static java.util.List<HarvestedItemInfo>	harvest(Context context, DSpaceObject scope, java.lang.String startDate, java.lang.String endDate, int offset, int limit, boolean items, boolean collections, boolean withdrawn, boolean nonAnon) Obtain information about items that have been created, modified or withdrawn within a given date range.

Methods inherited from class java.lang.Object

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

Constructor Detail

Harvest

public Harvest()

Method Detail

harvest

public static java.util.List<HarvestedItemInfo> harvest(Context context,
                                        DSpaceObject scope,
                                        java.lang.String startDate,
                                        java.lang.String endDate,
                                        int offset,
                                        int limit,
                                        boolean items,
                                        boolean collections,
                                        boolean withdrawn,
                                        boolean nonAnon)
                                                 throws java.sql.SQLException,
                                                        java.text.ParseException

Obtain information about items that have been created, modified or withdrawn within a given date range. You can also specify 'offset' and 'limit' so that a big harvest can be split up into smaller sections.

Note that dates are passed in the standard ISO8601 format used by DSpace (and OAI-PMH).

FIXME: Assumes all in_archive items have public metadata

Parameters:

context - DSpace context

scope - a Collection, Community, or null indicating the scope is all of DSpace

startDate - start of date range, or null

endDate - end of date range, or null

offset - for a partial harvest, the point in the overall list of matching items to start at. 0 means just start at the beginning.

limit - the number of matching items to return in a partial harvest. Specify 0 to return the whole list (or the rest of the list if an offset was specified.)

items - if true the item field of each HarvestedItemInfo object is filled out

collections - if true the collectionHandles field of each HarvestedItemInfo object is filled out

withdrawn - If true, information about withdrawn items is included

nonAnon - If items without anonymous access should be included or not

Returns:

List of HarvestedItemInfo objects

Throws:

java.sql.SQLException

java.text.ParseException - If the date is not in a supported format

getSingle

public static HarvestedItemInfo getSingle(Context context,
                          java.lang.String handle,
                          boolean collections)
                                   throws java.sql.SQLException

Get harvested item info for a single item. item field in returned HarvestedItemInfo object is always filled out.

Parameters:

context - DSpace context

handle - Prefix-less Handle of item

collections - if true the collectionHandles field of the HarvestedItemInfo object is filled out

Returns:

HarvestedItemInfo object for the single item, or null

Throws:

java.sql.SQLException