Package com.illumon.iris.controller

Class IrisQuerySchedulerRange

java.lang.Object

com.illumon.iris.controller.IrisQueryScheduler

com.illumon.iris.controller.IrisQuerySchedulerRange

All Implemented Interfaces:

IrisScheduler

public class IrisQuerySchedulerRange
extends IrisQueryScheduler
implements IrisScheduler

Implementation of IrisScheduler for queries that run over ranges.

Nested Class Summary

Nested classes/interfaces inherited from class com.illumon.iris.controller.IrisQueryScheduler

IrisQueryScheduler.RestartWhenRunning

Field Summary

Fields inherited from class com.illumon.iris.controller.IrisQueryScheduler

DISABLED_PARSE_STRING, overnight, RESTART_COUNT_UNLIMITED, timeZone

Fields inherited from interface com.illumon.iris.controller.IrisScheduler

DELIMITER_TOKEN, SCHEDULER_TYPE_TOKEN

Constructor Summary

Constructors

Constructor	Description
IrisQuerySchedulerRange()	No-arg constructor for creation from string array.
IrisQuerySchedulerRange(String startTime, String stopTime, String timeZone, boolean schedulingDisabled, boolean overnight, boolean repeatEnabled, String repeatInterval, boolean skipIfUnsuccessful, boolean stopTimeDisabled, int errorRestartCount, String restartDelayMinutes, IrisQueryScheduler.RestartWhenRunning restartWhenRunning, String startDate, String stopDate, boolean useStartDateTime, boolean useStopDateTime)	Constructor called with scheduling parameters.

Method Summary

Modifier and Type	Method	Description
boolean	enforceStartStopTimeOrder()	Indicate whether default validation should enforce the start and stop time ordering.
boolean	equals(Object object)
void	generateSchedulerTimes(Long lookPastTime, Map<Long,PersistentQueryInfo> queryInfos)	Generate the next start/stop time values for this query.
String[]	generateStringArrayFromScheduler()
String	getScheduleDetailDisplay(String[] strings, Map<Long,PersistentQueryInfo> queryInfos)
String	getStartDateString()
String	getStopDateString()
long	getStopTimeInMillis()	Return the scheduler's next scheduled stop time.
void	populateSchedulerFromStringArray(String[] strings)
boolean	useStartDateTime()	Indicate whether the start time/date option is used.
boolean	useStopDateTime()	Indicate whether the stop time/date option is used.
void	validate(Map<Long,PersistentQueryInfo> allConfigurations)	Validate the scheduling.

Methods inherited from class com.illumon.iris.controller.IrisQueryScheduler

getRepeatInterval, getRestartDelayMinutes, getRestartErrorCount, getRestartWhenRunning, getRestartWhenRunningValues, getSchedulingDisabled, getStartTime, getStartTimeDisplay, getStartTimeInMillis, getStartTimeOfDay, getStopTime, getStopTimeDisplay, getStopTimeOfDay, getTimeZoneDisplay, getTimeZoneString, hasStartTime, hasStopTime, isOvernight, isRepeatEnabled, isStartTimeFirstForDay, isStopTimeDisabled, shouldRestartWhenRunning, skipIfUnsuccessful

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.controller.IrisScheduler

areConditionsMet, getDependentOnQuerySerials, getExpirationTimeMillis, getRepeatInterval, getRestartDelayMinutes, getRestartErrorCount, getRunOnFailure, getSchedulingDisabled, getStartTimeDisplay, getStartTimeInMillis, getStartTimeOfDay, getStopTimeDisplay, getStopTimeOfDay, getTemporaryQueueName, getTimeZoneDisplay, getTimeZoneString, hasStopTime, isAutoDelete, isOvernight, isRepeatEnabled, isStartTimeFirstForDay, setDependentOnQuerySerials, shouldRestartWhenRunning, skipIfUnsuccessful, updateDependencyState, updateDependencyState

Constructor Details

IrisQuerySchedulerRange

public IrisQuerySchedulerRange()

No-arg constructor for creation from string array. This will be called reflexively by the factory.

IrisQuerySchedulerRange

public IrisQuerySchedulerRange(String startTime,
 String stopTime,
 String timeZone,
 boolean schedulingDisabled,
 boolean overnight,
 boolean repeatEnabled,
 String repeatInterval,
 boolean skipIfUnsuccessful,
 boolean stopTimeDisabled,
 int errorRestartCount,
 String restartDelayMinutes,
 IrisQueryScheduler.RestartWhenRunning restartWhenRunning,
 String startDate,
 String stopDate,
 boolean useStartDateTime,
 boolean useStopDateTime)

Constructor called with scheduling parameters.

Parameters:

startTime - the query's start time

stopTime - the query's stop time

timeZone - the time zone for the dates and times

schedulingDisabled - if true, scheduling is disabled

overnight - unused but required by IrisQueryScheduler constructor

repeatEnabled - if true, it's a repeating PQ

repeatInterval - if repeating, the interval

skipIfUnsuccessful - unused but required by IrisQueryScheduler constructor

stopTimeDisabled - indicates whether the stop time is used to stop the PQ

errorRestartCount - the number of times a failing PQ should be restarted

restartDelayMinutes - the delay between restart attempts for a failing PQ

restartWhenRunning - if true, restart the PQ when its restart time arrives even if it's running

startDate - the query's start date

stopDate - the query's stop date

useStartDateTime - if true, the option to use a start date/time is selected

useStopDateTime - if true, the option to use a stop date/time is selected

Method Details

generateStringArrayFromScheduler

public String[] generateStringArrayFromScheduler()

Specified by:

generateStringArrayFromScheduler in interface IrisScheduler

populateSchedulerFromStringArray

public void populateSchedulerFromStringArray(String[] strings)

Specified by:

populateSchedulerFromStringArray in interface IrisScheduler

equals

public boolean equals(Object object)

Overrides:

equals in class IrisQueryScheduler

generateSchedulerTimes

public void generateSchedulerTimes(Long lookPastTime,
 Map<Long,PersistentQueryInfo> queryInfos)

Description copied from interface: IrisScheduler

Generate the next start/stop time values for this query. Generated values of -1 will be used to indicate no start or stop time. After calling this, calling getStartTimeInMillis will return the generated start time and calling getStopTimeInMillis will return the generated stop time.

Specified by:

generateSchedulerTimes in interface IrisScheduler

Parameters:

lookPastTime - the time in millis past which the scheduling engine looks for the next start time, or null if none is desired

queryInfos - the controller's query information Map

getStopTimeInMillis

public long getStopTimeInMillis()

Description copied from interface: IrisScheduler

Return the scheduler's next scheduled stop time. This must be called after IrisScheduler.generateSchedulerTimes(Long, Map). A value of -1 means there is no stop time.

Specified by:

getStopTimeInMillis in interface IrisScheduler

Overrides:

getStopTimeInMillis in class IrisQueryScheduler

Returns:

the query's next start time in millis

getScheduleDetailDisplay

public String getScheduleDetailDisplay(String[] strings,
 Map<Long,PersistentQueryInfo> queryInfos)

Specified by:

getScheduleDetailDisplay in interface IrisScheduler

validate

public void validate(Map<Long,PersistentQueryInfo> allConfigurations)

Description copied from interface: IrisScheduler

Validate the scheduling.

Specified by:

validate in interface IrisScheduler

Overrides:

validate in class IrisQueryScheduler

Parameters:

allConfigurations - a map of all current query configurations which can be used for additional validation

getStartDateString

public String getStartDateString()

getStopDateString

public String getStopDateString()

useStartDateTime

public boolean useStartDateTime()

Indicate whether the start time/date option is used.

Returns:

true if the start date/time option is selected

useStopDateTime

public boolean useStopDateTime()

Indicate whether the stop time/date option is used.

Returns:

true if the stop date/time option is selected

enforceStartStopTimeOrder

public boolean enforceStartStopTimeOrder()

Description copied from interface: IrisScheduler

Indicate whether default validation should enforce the start and stop time ordering. If this is false (for example when it's a multi-day scheduler), the scheduler implementation should enforce start and stop ordering in its IrisScheduler.validate(java.util.Map<java.lang.Long, com.illumon.iris.controller.PersistentQueryInfo>) implementation.

Specified by:

enforceStartStopTimeOrder in interface IrisScheduler

Overrides:

enforceStartStopTimeOrder in class IrisQueryScheduler

Returns:

true if default validation should enforce the start and stop time ordering