com.aspc.workflow

Class EventGenerator

java.lang.Object

com.supertracker.Startup.Tasks.InternalTask

com.aspc.workflow.EventGenerator

All Implemented Interfaces:

ServerProcess, java.lang.Runnable

public class EventGenerator
extends InternalTask

EventGenerator
THREAD MODE: SINGLE-THREADED

Since:

June 15, 2004

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
EventGenerator() To run on active layers

Method Summary

Modifier and Type	Method and Description
protected void	finishUp(boolean forceStop) Wait for processes to finish
DBTask	getDBTask() Retrieves the EVENT_GEN task so that this task will be notified that we are still running.
protected boolean	isRunning(DBEventCondition ec, VirtualDB vDB) Determines if the Event is currently being processed
void	process() Scans each database layer searching for Periodic events that are now valid
protected void	processEvents(VirtualDB layer) Retrieves the list of periodic events and calls the scan method for each.
void	scanDB(int layerID) Determines if this layer requires scanning and if it does calls processEvents
protected boolean	shouldRunCondition(DBEventCondition ec, VirtualDB vDB) Determines if this event should be tested based on the scan interval If the event is currently running then we do not run again

Methods inherited from class com.supertracker.Startup.Tasks.InternalTask

creatSchedule, disableHA, doError, enableHA, execute, getDBTask, getDisplayName, getInitialScanTime, getOccurences, getParameterFile, getParameterValues, getRepeatEvery, getTaskBeatLayer, getTimeZone, heartBeat, isBatchMode, isTerminated, join, join, makeIdle, makeThreadName, parseTime, pause, paused, resumed, run, setBatchMode, setDelayStart, setDisplayName, setOccurences, setParameterFile, setParameterValue, setRepeat, setRepeatEvery, setRepeatEvery, setStartTime, setTaskBeatLayer, setTimeZoneId, terminate, terminated, waitOrRepeat

Methods inherited from class java.lang.Object

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

Constructor Detail

EventGenerator

public EventGenerator()

To run on active layers

Method Detail

process

public void process()
             throws java.lang.Exception

Scans each database layer searching for Periodic events that are now valid

Overrides:

process in class InternalTask

Throws:

java.lang.Exception - - a serious error

scanDB

public void scanDB(int layerID)

Determines if this layer requires scanning and if it does calls processEvents

Parameters:

layerID - - layer id

processEvents

protected void processEvents(@Nonnull
                             VirtualDB layer)
                      throws NotFoundException

Retrieves the list of periodic events and calls the scan method for each.

Parameters:

layer - - layer being processed

Throws:

NotFoundException

shouldRunCondition

@CheckReturnValue
protected boolean shouldRunCondition(@Nonnull
                                                       DBEventCondition ec,
                                                       @Nonnull
                                                       VirtualDB vDB)
                                                throws NotFoundException

Determines if this event should be tested based on the scan interval If the event is currently running then we do not run again

Parameters:

ec - - event

vDB - - current layer

Returns:

- true if the data associated with the event should be scanned

Throws:

NotFoundException

isRunning

@CheckReturnValue
protected final boolean isRunning(@Nonnull
                                                    DBEventCondition ec,
                                                    @Nonnull
                                                    VirtualDB vDB)

Determines if the Event is currently being processed

Parameters:

ec - - event

vDB - - current layer

Returns:

- true if the data associated with the event should be scanned

finishUp

protected void finishUp(boolean forceStop)

Wait for processes to finish

Overrides:

finishUp in class InternalTask

Parameters:

forceStop - - true if process was manually canceled rather then finishing naturally

getDBTask

@Nullable
public DBTask getDBTask()

Retrieves the EVENT_GEN task so that this task will be notified that we are still running.

Overrides:

getDBTask in class InternalTask

Returns:

- DBTask associated with the generator