org.opennms.netmgt.config
Class BasicScheduleUtils

java.lang.Object
  org.opennms.netmgt.config.BasicScheduleUtils

public class BasicScheduleUtils
extends Object

BasicScheduleUtils class.

Version:

$Id: $

Author:

ranger

Field Summary

static String	FORMAT1 Constant FORMAT1="dd-MMM-yyyy HH:mm:ss"
static String	FORMAT2 Constant FORMAT2="HH:mm:ss"
protected static Map<String,Integer>	m_dayOfWeekMap The day of the week values to name mapping

Constructor Summary

BasicScheduleUtils()

Method Summary

static Date	getDailyTime(Date referenceTime, String timeString) getDailyTime
static Integer	getDayOfWeekIndex(String dayName) getDayOfWeekIndex
static Calendar	getEndOfSchedule(BasicSchedule out) getEndOfSchedule
static OwnedInterval	getInterval(Date ref, Time time, Owner owner) getInterval
static OwnedIntervalSequence	getIntervals(Date start, Date end, Time time, Owner owner) getIntervals
static OwnedIntervalSequence	getIntervals(TimeInterval interval, Time time, Owner owner) getIntervals
static OwnedIntervalSequence	getIntervalsCovering(Date start, Date end, BasicSchedule sched, Owner owner) getIntervalsCovering
static OwnedIntervalSequence	getIntervalsCovering(TimeInterval interval, BasicSchedule sched, Owner owner) getIntervalsCovering
static Date	getMonthlyTime(Date referenceTime, String day, String timeString) getMonthlyTime
static Date	getSpecificTime(String specificString) getSpecificTime
static Date	getWeeklyTime(Date referenceTime, String day, String timeString) getWeeklyTime
static boolean	isDaily(Time time) isDaily
static boolean	isMonthly(Time time) isMonthly
static boolean	isSpecific(Time time) isSpecific
static boolean	isTimeInSchedule(Calendar cal, BasicSchedule sched) isTimeInSchedule
static boolean	isTimeInSchedule(Date time, BasicSchedule sched) isTimeInSchedule
static boolean	isWeekly(Time time) isWeekly
static Date	nextDay(Date date) nextDay
static Date	nextMonth(Date date) nextMonth
static Date	nextWeek(Date date) nextWeek
static void	setOutCalTime(Calendar outCal, String timeStr) Set the time in outCal from timeStr.

Methods inherited from class java.lang.Object

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

Field Detail

m_dayOfWeekMap

protected static Map<String,Integer> m_dayOfWeekMap

The day of the week values to name mapping

FORMAT1

public static String FORMAT1

Constant FORMAT1="dd-MMM-yyyy HH:mm:ss"

FORMAT2

public static String FORMAT2

Constant FORMAT2="HH:mm:ss"

Constructor Detail

BasicScheduleUtils

public BasicScheduleUtils()

Method Detail

isTimeInSchedule

public static boolean isTimeInSchedule(Calendar cal,
                                       BasicSchedule sched)

isTimeInSchedule

Parameters:

cal - a Calendar object.

sched - a BasicSchedule object.

Returns:

a boolean.

setOutCalTime

public static void setOutCalTime(Calendar outCal,
                                 String timeStr)

Set the time in outCal from timeStr. 'timeStr'is in either the 'dd-MMM-yyyy HH:mm:ss' or the 'HH:mm:ss' formats

Parameters:

outCal - the calendar in which time is to be set

timeStr - the time string

getDayOfWeekIndex

public static Integer getDayOfWeekIndex(String dayName)

getDayOfWeekIndex

Parameters:

dayName - a String object.

Returns:

a Integer object.

getEndOfSchedule

public static Calendar getEndOfSchedule(BasicSchedule out)

getEndOfSchedule

Parameters:

out - a BasicSchedule object.

Returns:

a Calendar object.

isTimeInSchedule

public static boolean isTimeInSchedule(Date time,
                                       BasicSchedule sched)

isTimeInSchedule

Parameters:

time - a Date object.

sched - a BasicSchedule object.

Returns:

a boolean.

isDaily

public static boolean isDaily(Time time)

isDaily

Parameters:

time - a Time object.

Returns:

a boolean.

isWeekly

public static boolean isWeekly(Time time)

isWeekly

Parameters:

time - a Time object.

Returns:

a boolean.

isMonthly

public static boolean isMonthly(Time time)

isMonthly

Parameters:

time - a Time object.

Returns:

a boolean.

isSpecific

public static boolean isSpecific(Time time)

isSpecific

Parameters:

time - a Time object.

Returns:

a boolean.

getSpecificTime

public static Date getSpecificTime(String specificString)

getSpecificTime

Parameters:

specificString - a String object.

Returns:

a Date object.

getMonthlyTime

public static Date getMonthlyTime(Date referenceTime,
                                  String day,
                                  String timeString)

getMonthlyTime

Parameters:

referenceTime - a Date object.

day - a String object.

timeString - a String object.

Returns:

a Date object.

getWeeklyTime

public static Date getWeeklyTime(Date referenceTime,
                                 String day,
                                 String timeString)

getWeeklyTime

Parameters:

referenceTime - a Date object.

day - a String object.

timeString - a String object.

Returns:

a Date object.

getDailyTime

public static Date getDailyTime(Date referenceTime,
                                String timeString)

getDailyTime

Parameters:

referenceTime - a Date object.

timeString - a String object.

Returns:

a Date object.

getInterval

public static OwnedInterval getInterval(Date ref,
                                        Time time,
                                        Owner owner)

getInterval

Parameters:

ref - a Date object.

time - a Time object.

owner - a Owner object.

Returns:

a OwnedInterval object.

nextDay

public static Date nextDay(Date date)

nextDay

Parameters:

date - a Date object.

Returns:

a Date object.

nextWeek

public static Date nextWeek(Date date)

nextWeek

Parameters:

date - a Date object.

Returns:

a Date object.

nextMonth

public static Date nextMonth(Date date)

nextMonth

Parameters:

date - a Date object.

Returns:

a Date object.

getIntervals

public static OwnedIntervalSequence getIntervals(Date start,
                                                 Date end,
                                                 Time time,
                                                 Owner owner)

getIntervals

Parameters:

start - a Date object.

end - a Date object.

time - a Time object.

owner - a Owner object.

Returns:

a OwnedIntervalSequence object.

getIntervals

public static OwnedIntervalSequence getIntervals(TimeInterval interval,
                                                 Time time,
                                                 Owner owner)

getIntervals

Parameters:

interval - a TimeInterval object.

time - a Time object.

owner - a Owner object.

Returns:

a OwnedIntervalSequence object.

getIntervalsCovering

public static OwnedIntervalSequence getIntervalsCovering(Date start,
                                                         Date end,
                                                         BasicSchedule sched,
                                                         Owner owner)

getIntervalsCovering

Parameters:

start - a Date object.

end - a Date object.

sched - a BasicSchedule object.

owner - a Owner object.

Returns:

a OwnedIntervalSequence object.

getIntervalsCovering

public static OwnedIntervalSequence getIntervalsCovering(TimeInterval interval,
                                                         BasicSchedule sched,
                                                         Owner owner)

getIntervalsCovering

Parameters:

interval - a TimeInterval object.

sched - a BasicSchedule object.

owner - a Owner object.

Returns:

a OwnedIntervalSequence object.