org.oddjob.scheduling

Class ScheduleBase

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.scheduling.ScheduleBase

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resetable, Stateful, Stoppable, Structural

Direct Known Subclasses:

TimerBase, Trigger

public abstract class ScheduleBase
extends BasePrimary
implements java.lang.Runnable, Stoppable, java.io.Serializable, Resetable, Stateful, Structural, Forceable

Common functionality for jobs that schedule things.

See Also:

Serialized Form

Author:

Rob Gordon

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.CountDownLatch	begun
protected ChildHelper<java.lang.Runnable>	childHelper Track the child.
protected StateExchange<TimerState>	childStateReflector
protected TimerStateHandler	stateHandler Fires state events.
protected boolean	stop Stop flag.

Constructor Summary

Constructors

Constructor and Description
ScheduleBase() Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	addStructuralListener(StructuralListener listener) Add a listener.
protected abstract void	begin() Sub classes must override this to submit the first execution.
protected void	fireDestroyedState() Internal method to fire state.
void	force() Force something.
protected StateChanger<TimerState>	getStateChanger()
protected abstract StateOperator	getStateOp() Sub classes provide the state operator that is used to calculate the subclasses completion state.
boolean	hardReset() Perform a hard reset on the job.
protected IconHelper	iconHelper() Subclasses must provide a IconHelper.
protected void	onDestroy() Subclasses override this method to clear up resources.
protected void	onReset() Override by subclasses to reset state.
protected void	onStop() Subclasses can override to perform stopping operations.
protected void	postStop() Subclasses can override to perform actions once children have stopped.
void	removeStructuralListener(StructuralListener listener) Remove a listener.
void	run() Implement the main execute method for a job.
boolean	softReset() Perform a soft reset on the job.
protected TimerStateHandler	stateHandler() Subclasses must provide a StateHandler.
void	stop() Implementation for a typical stop.

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Field Detail

stateHandler

protected transient volatile TimerStateHandler stateHandler

Fires state events.

childHelper

protected transient volatile ChildHelper<java.lang.Runnable> childHelper

Track the child.

childStateReflector

protected transient volatile StateExchange<TimerState> childStateReflector

stop

protected transient volatile boolean stop

Stop flag.

begun

protected transient volatile java.util.concurrent.CountDownLatch begun

Constructor Detail

ScheduleBase

public ScheduleBase()

Default Constructor.

Method Detail

stateHandler

protected TimerStateHandler stateHandler()

Description copied from class: BaseComponent

Subclasses must provide a StateHandler.

Specified by:

stateHandler in class BaseComponent

Returns:

A State Handler. Never null.

iconHelper

protected IconHelper iconHelper()

Description copied from class: BaseComponent

Subclasses must provide a IconHelper.

Specified by:

iconHelper in class BaseComponent

Returns:

An Icon Helper. Never null.

getStateChanger

protected StateChanger<TimerState> getStateChanger()

getStateOp

protected abstract StateOperator getStateOp()

Sub classes provide the state operator that is used to calculate the subclasses completion state.

Returns:

The operator. Must not be null.

begin

protected abstract void begin()
                       throws ComponentPersistException

Sub classes must override this to submit the first execution.

Throws:

ComponentPerisistException - If the scheduled time can't be saved.

ComponentPersistException

run

public final void run()

Implement the main execute method for a job. This surrounds the doExecute method of the sub class and sets state for the job.

Specified by:

run in interface java.lang.Runnable

stop

public final void stop()
                throws FailedToStopException

Implementation for a typical stop. Subclasses must implement Stoppable to take advantage of it.

This stop implementation doesn't check that the job is executing as stop messages must cascade down the hierarchy to manually started jobs.

Specified by:

stop in interface Stoppable

Throws:

FailedToStopException

onStop

protected void onStop()

Subclasses can override to perform stopping operations.

postStop

protected void postStop()

Subclasses can override to perform actions once children have stopped.

softReset

public boolean softReset()

Perform a soft reset on the job.

Specified by:

softReset in interface Resetable

Returns:

true if successful.

hardReset

public boolean hardReset()

Perform a hard reset on the job.

Specified by:

hardReset in interface Resetable

Returns:

true if successful.

onReset

protected void onReset()

Override by subclasses to reset state.

force

public void force()

Description copied from interface: Forceable

Force something. Generally this will be the state of a job to COMPLETE but other uses may be found.

Specified by:

force in interface Forceable

addStructuralListener

public void addStructuralListener(StructuralListener listener)

Add a listener. The listener will immediately recieve add notifications for all existing children.

Specified by:

addStructuralListener in interface Structural

Parameters:

listener - The listener.

removeStructuralListener

public void removeStructuralListener(StructuralListener listener)

Remove a listener.

Specified by:

removeStructuralListener in interface Structural

Parameters:

listener - The listner.

onDestroy

protected void onDestroy()

Description copied from class: BaseComponent

Subclasses override this method to clear up resources. This is called by the framework before child elements have been destroyed.

Overrides:

onDestroy in class BaseComponent

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent