stella

Class AbstractScheduler

java.lang.Object

util.PropertyContainer

util.PropertyResources

stella.AbstractScheduler

All Implemented Interfaces:

Cloneable, Scheduling, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

XMLScheduler

public abstract class AbstractScheduler
extends PropertyResources
implements Scheduling, Initializable

An abstract implementation of the Scheduling interface. Provided are methods for loading a target list and for registering a set of globals. A constructor using a single Map object as argument is provided.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<Appointable.Constraint>	global The collection of global constraints currently assigned.
private Object	sleeper Notify this object if asked to.

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScheduler(Map<String,String> sprop) Protected constructer defining this schedulers properties.

Method Summary

Modifier and Type	Method and Description
void	addGlobalConstraint(Appointable.Constraint cons) Adds a global constraint to the scheduler.
protected boolean	checkGlobalConstraints(GlobalGrouping set, Appointable target) Checks, if the target is observable under all global constraints.
static Scheduling	createScheduler(Map<String,String> prop) Constructs a new scheduling instance using the mapping of the PropertySupplying.KEY_CLASS to the class name to derive the class to instantiate.
Collection<Appointable.Constraint>	getGlobalConstraints() Returns a collection of all currently registered global constraints.
Collection<Appointable>	getObservableTargets(GlobalGrouping set, Collection<Appointable> targets) Shortens the list of targets to all targets that are currently observable.
void	init()
Object	registerMonitor(Object waiter) Registers an object for notification.
void	removeAllGlobalConstraints() Removes all global constraints.
void	removeGlobalConstraint(Appointable.Constraint cons) Removes a global constraint from the scheduler.
protected void	wakeUp() Notifies the sleeping object if it is set.

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface stella.Scheduling

getHighestTarget

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail

global

private Collection<Appointable.Constraint> global

The collection of global constraints currently assigned.

sleeper

private Object sleeper

Notify this object if asked to.

Constructor Detail

AbstractScheduler

protected AbstractScheduler(Map<String,String> sprop)

Protected constructer defining this schedulers properties.

Method Detail

init

public void init()

Specified by:

init in interface Initializable

addGlobalConstraint

public void addGlobalConstraint(Appointable.Constraint cons)

Adds a global constraint to the scheduler.

Specified by:

addGlobalConstraint in interface Scheduling

removeGlobalConstraint

public void removeGlobalConstraint(Appointable.Constraint cons)

Removes a global constraint from the scheduler.

Specified by:

removeGlobalConstraint in interface Scheduling

removeAllGlobalConstraints

public void removeAllGlobalConstraints()

Removes all global constraints.

Specified by:

removeAllGlobalConstraints in interface Scheduling

getGlobalConstraints

public Collection<Appointable.Constraint> getGlobalConstraints()

Returns a collection of all currently registered global constraints. If no globals have been added, null is returned.

Specified by:

getGlobalConstraints in interface Scheduling

registerMonitor

public Object registerMonitor(Object waiter)

Registers an object for notification. If the method wakeUp() is called after an object has been registered the argumental objects is notified of any change happened to the sequencer. Due to the synchronizing behaviour of the wakeUp() method, care must be taken to avoid dead-lock.

Specified by:

registerMonitor in interface Scheduling

Returns:

The previously monitored object.

getObservableTargets

public Collection<Appointable> getObservableTargets(GlobalGrouping set,
                                                    Collection<Appointable> targets)

Shortens the list of targets to all targets that are currently observable. Does this by checking the global requirement and by calculating the remaining time from the constraints. Only targets that have a remaining time higher then zero survive.

Specified by:

getObservableTargets in interface Scheduling

Returns:

observable A list of currently observable targets

checkGlobalConstraints

protected boolean checkGlobalConstraints(GlobalGrouping set,
                                         Appointable target)

Checks, if the target is observable under all global constraints.

wakeUp

protected void wakeUp()

Notifies the sleeping object if it is set. Tries to synchronize on the object prior to notification.

createScheduler

public static final Scheduling createScheduler(Map<String,String> prop)

Constructs a new scheduling instance using the mapping of the PropertySupplying.KEY_CLASS to the class name to derive the class to instantiate. If this property is defined, a new Scheduling instance with the stated class name is created, the supplied properties used as an argument in the constructor. Can throw a lot of exceptions if unsuccessful.