dk.netarkivet.harvester.datamodel
Class HourlyFrequency

java.lang.Object
  extended by dk.netarkivet.harvester.datamodel.Frequency
      extended by dk.netarkivet.harvester.datamodel.HourlyFrequency

public class HourlyFrequency
extends Frequency

This class implements a frequency of a number of hours.


Constructor Summary
HourlyFrequency(int numUnits)
          Create a new HourlyFrequency that happens every numUnits hours, at an unspecified minute.
HourlyFrequency(int numUnits, int minute)
          Create a new HourlyFrequency that happens every numUnits hours, on the minute.
 
Method Summary
 boolean equals(java.lang.Object o)
          Autogenerated equals.
 java.util.Date getFirstEvent(java.util.Date startTime)
          Given a starting time, tell us when the first event should happen.
 int getMinute()
          If not anytime, the minute at which events should start.
 java.util.Date getNextEvent(java.util.Date lastEvent)
          Given when the last event happened, tell us when the next event should happen (even if the new event is in the past).
 java.lang.Integer getOnDayOfMonth()
          Return the exact day of month event should happen on, or null if this is an anyTime event or doesn't define what day of month it should happen on.
 java.lang.Integer getOnDayOfWeek()
          Return the exact day of week event should happen on, or null if this is an anyTime event or doesn't define what day of week it should happen on.
 java.lang.Integer getOnHour()
          Return the exact hour event should happen on, or null if this is an anyTime event or doesn't define what hour it should happen on.
 java.lang.Integer getOnMinute()
          Return the exact minute event should happen on, or null if this is an anyTime event or doesn't define what minute it should happen on.
 int hashCode()
          Autogenerated hashcode method.
 int ordinal()
          Return an integer that can be used to identify the kind of frequency.
 java.lang.String toString()
          Human readable representation of this object.
 
Methods inherited from class dk.netarkivet.harvester.datamodel.Frequency
getNewInstance, getNumUnits, isAnytime
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HourlyFrequency

public HourlyFrequency(int numUnits)
Create a new HourlyFrequency that happens every numUnits hours, at an unspecified minute.

Parameters:
numUnits - Number of hours from one event to the next
Throws:
ArgumentNotValid - if numUnits if 0 or negative

HourlyFrequency

public HourlyFrequency(int numUnits,
                       int minute)
Create a new HourlyFrequency that happens every numUnits hours, on the minute.

Parameters:
numUnits - Number of hours from one event to the next
minute - What minute of the hour the event should happen on.
Throws:
ArgumentNotValid - if numUnits if 0 or negative or minutes is <0 or >59
Method Detail

getNextEvent

public java.util.Date getNextEvent(java.util.Date lastEvent)
Given when the last event happened, tell us when the next event should happen (even if the new event is in the past). The time of the next event is guaranteed to be later that lastEvent. For certain frequencies (e.g. once a day, any time of day), the time of the next event is derived from lastEvent, for others (e.g. once a day at 13:00) the time of the next event is the first matching time after lastEvent.

Specified by:
getNextEvent in class Frequency
Parameters:
lastEvent - A time from which the next event should be calculated.
Returns:
At what point the event should happen next.
Throws:
ArgumentNotValid - if lastEvent is null

getFirstEvent

public java.util.Date getFirstEvent(java.util.Date startTime)
Given a starting time, tell us when the first event should happen.

Specified by:
getFirstEvent in class Frequency
Parameters:
startTime - The earliest time the event can happen.
Returns:
At what point the event should happen the first time.
Throws:
ArgumentNotValid - if startTime is null

getMinute

public int getMinute()
If not anytime, the minute at which events should start.

Returns:
the minute

equals

public boolean equals(java.lang.Object o)
Autogenerated equals.

Overrides:
equals in class Frequency
Parameters:
o - The object to compare with
Returns:
Whether objects are equal

hashCode

public int hashCode()
Autogenerated hashcode method.

Overrides:
hashCode in class Frequency
Returns:
the hashcode

getOnMinute

public java.lang.Integer getOnMinute()
Return the exact minute event should happen on, or null if this is an anyTime event or doesn't define what minute it should happen on.

Specified by:
getOnMinute in class Frequency
Returns:
the exact minute event should happen on

getOnHour

public java.lang.Integer getOnHour()
Return the exact hour event should happen on, or null if this is an anyTime event or doesn't define what hour it should happen on.

Specified by:
getOnHour in class Frequency
Returns:
null always

getOnDayOfWeek

public java.lang.Integer getOnDayOfWeek()
Return the exact day of week event should happen on, or null if this is an anyTime event or doesn't define what day of week it should happen on.

Specified by:
getOnDayOfWeek in class Frequency
Returns:
null always

getOnDayOfMonth

public java.lang.Integer getOnDayOfMonth()
Return the exact day of month event should happen on, or null if this is an anyTime event or doesn't define what day of month it should happen on.

Specified by:
getOnDayOfMonth in class Frequency
Returns:
null (always)

ordinal

public int ordinal()
Return an integer that can be used to identify the kind of frequency. No two subclasses should use the same integer

Specified by:
ordinal in class Frequency
Returns:
an integer that can be used to identify the kind of frequency

toString

public java.lang.String toString()
Human readable representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
Human readable representation