stella

Interface Scheduling

All Superinterfaces:

PropertySupplying

All Known Implementing Classes:

AbstractScheduler, PointingScheduler, XMLScheduler

public interface Scheduling
extends PropertySupplying

The interface comprising scheduling capabilities. This interfaces is used by the master mind to communicate with a scheduler. The methods have the following overall useage.

• getHighestTarget(globals.GlobalGrouping, java.util.Collection<stella.Appointable>): This method returns the target with the highest priority in the moment this method was invoked. Additionally, the scheduler should set globals refering to the target, like target ra.
• registerMonitor(java.lang.Object) is intended to register an other object that may wait for notification from the scheduler. It may be used for times where no targets are available. This method is rather obsolete and replaced with EventTrigger.registerMonitor(java.lang.Object).

Note that remote access to the scheduler's target list will be in almost any case required. Concrete implementations will therefore additionally implement the stella.rmi.SchedulingControl interface.

For convenience an abstract AbstractScheduler is provided. This class follows the recommended construction schema, taking a Properties object as the single constructor argument.

Field Summary

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

Modifier and Type	Method and Description
void	addGlobalConstraint(Appointable.Constraint constraint) Adds a global constraint to the scheduler.
Collection<Appointable.Constraint>	getGlobalConstraints() Returns all global constraints.
Appointable	getHighestTarget(GlobalGrouping cond, Collection<Appointable> lst) Scans a specified set of target definitions for the target with the highest priority within this set.
Collection<Appointable>	getObservableTargets(GlobalGrouping cond, Collection<Appointable> list) Scans a specified set of targets and returns all of them that are observable.
Object	registerMonitor(Object waiter) Registers an object for notification.
void	removeAllGlobalConstraints() Removes all global constraints.
void	removeGlobalConstraint(Appointable.Constraint constraint) Removes a global constraint.

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

Method Detail

getObservableTargets

Collection<Appointable> getObservableTargets(GlobalGrouping cond,
                                             Collection<Appointable> list)

Scans a specified set of targets and returns all of them that are observable.

Returns:

observable A list of currently observable targets

getHighestTarget

Appointable getHighestTarget(GlobalGrouping cond,
                             Collection<Appointable> lst)

Scans a specified set of target definitions for the target with the highest priority within this set.

registerMonitor

Object registerMonitor(Object waiter)

Registers an object for notification. Probably not useful for normal scheduling process because change of scheduling conditions will be hard to recognize for a scheduler.

addGlobalConstraint

void addGlobalConstraint(Appointable.Constraint constraint)

Adds a global constraint to the scheduler. All targets undergoing a selection process via getHighestTarget(globals.GlobalGrouping, java.util.Collection<stella.Appointable>) must also fulfill all global constraints.

removeAllGlobalConstraints

void removeAllGlobalConstraints()

Removes all global constraints.

removeGlobalConstraint

void removeGlobalConstraint(Appointable.Constraint constraint)

Removes a global constraint.

getGlobalConstraints

Collection<Appointable.Constraint> getGlobalConstraints()

Returns all global constraints.