Package dk.netarkivet.harvester.datamodel

Class TimedSchedule

java.lang.Object

dk.netarkivet.harvester.datamodel.Schedule

dk.netarkivet.harvester.datamodel.TimedSchedule

All Implemented Interfaces:

Named, Serializable

public class TimedSchedule
extends Schedule

This class implements a schedule that runs over a specified period of time.

See Also:

Serialized Form

Field Summary

Fields inherited from class dk.netarkivet.harvester.datamodel.Schedule

comments, frequency, name, startDate

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Autogenerated equals.
Date	getEndDate()	Get the last possible time an event may be allowed.
Date	getNextEvent(Date lastEvent, int numPreviousEvents)	Return the date at which the next event will happen.
int	hashCode()	Autogenerated hashcode method.
String	toString()	Human readable represenation of this object.

Methods inherited from class dk.netarkivet.harvester.datamodel.Schedule

getComments, getEdition, getFirstEvent, getFrequency, getInstance, getInstance, getName, getStartDate, setComments, setEdition

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(Object o)

Autogenerated equals.

Overrides:

equals in class Schedule

Parameters:

o - The object to compare with

Returns:

Whether objects are equal

hashCode

public int hashCode()

Autogenerated hashcode method.

Overrides:

hashCode in class Schedule

Returns:

the hashcode

getNextEvent

public Date getNextEvent(Date lastEvent,
                         int numPreviousEvents)

Return the date at which the next event will happen. If the calculated next date is exactly equal to the end date then that value is returned. If it is after the end date, null is returned.

Specified by:

getNextEvent in class Schedule

Parameters:

lastEvent - The time at which the previous event happened. If this is null, then the method returns null. Ie once one is after the last event one is always after the last event.

numPreviousEvents - How many events have previously happened (ignored).

Returns:

The date of the next event to happen or null for no more events.

Throws:

ArgumentNotValid - if numPreviousEvents is negative

getEndDate

public Date getEndDate()

Get the last possible time an event may be allowed.

Returns:

The last date, null means no last date, continue forever.

toString

public String toString()

Human readable represenation of this object.

Overrides:

toString in class Object

Returns:

Human readble representation