stella.xml

Class XMLScheduler

java.lang.Object

util.PropertyContainer

util.PropertyResources

stella.AbstractScheduler

stella.xml.XMLScheduler

All Implemented Interfaces:

Cloneable, Scheduling, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

PointingScheduler

public class XMLScheduler
extends AbstractScheduler

An implementation of the Scheduling interface. An xml scheduler uses TargetDefinitions coming in the flavor of DOMTargets. The scheduler is responsible for selecting the next observation. This scheduler is a simple dispatch scheduler. The calculation of the individual observation's merits is deferred to the target itself, see ParsedTarget and the special subclasses of Meriting for further details.

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 static boolean	DEFALLOWNULL Default no null return on non-null observables allowed.
private static int	DEFMAXDEPTH Default maximum depth.
private Collection<Meriting>	globalmerit A list of global merits like user merits.
static String	KEY_ALLOWNULL Set this to true to allow also returns of null on no convergence.
static String	KEY_GLOBALCONSTRAINT The key linked to the properties of the global constraints.
static String	KEY_GLOBALMERIT The key linked to the properties of the global timeslot.
static String	KEY_GLOBALWATCH The key to the objects watched during night for their merit.
static String	KEY_MAXDEPTH Maximum number of loops.
private static int	level For debugging purpose we record the re-entrant level.
private List<String>	meritinfo A list of targets whose merit is matched during night.

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

Constructor and Description
XMLScheduler(Map<String,String> sprop) Constructs a new xml-scheduler.

Method Summary

Modifier and Type	Method and Description
boolean	addMeritTrace(Appointable app) We add the name of the appointable target to the merit info list, which means we will produce a log entry stating the current merit on any instance the target was observable.
private static double	getApparentMerit(GlobalGrouping set, Appointable dom, Collection<Appointable> targets, long within, Collection<Meriting> globalmerit) Calculates the apparent merit a target has, which includes global timeslots in addition to the target's own merit.
Appointable	getHighestTarget(GlobalGrouping set, Collection<Appointable> targets) Gets the target with the highest priority.
private static SortedSet<TargetDefinition>	getObservablesByPriority(Collection<Appointable> within)
protected static Appointable	highestFromAll(GlobalGrouping set, Collection<Appointable> all, Collection<Appointable> within, Collection<Meriting> globalmerit, int maxdepth) A re-entrant method to find the highest target.
private static Pair<Appointable,Double>	highestWithin(GlobalGrouping set, Collection<Appointable> targets, Collection<Appointable> observe, long within, Collection<Meriting> globalmerit) Returns the target with the highest merit within the stated time.
void	init() Initializes the scheduler.
(package private) static Appointable	oldHighestFromAll(GlobalGrouping set, Collection<Appointable> all, Collection<Appointable> within, Collection<Meriting> globalmerit) A re-entrant method to find the highest target.
boolean	removeMeritTrace(Appointable app) We remove the name of the target from the list of merit tracing.
private static Collection<Appointable>	retainTargets(GlobalGrouping set, Collection<Appointable> observable, long maxdur) Retains all targets in the returned collection whose observing time is less then the stated threshold.

Methods inherited from class stella.AbstractScheduler

addGlobalConstraint, checkGlobalConstraints, createScheduler, getGlobalConstraints, getObservableTargets, registerMonitor, removeAllGlobalConstraints, removeGlobalConstraint, wakeUp

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 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

KEY_GLOBALCONSTRAINT

public static final String KEY_GLOBALCONSTRAINT

The key linked to the properties of the global constraints.

See Also:

Constant Field Values

KEY_GLOBALMERIT

public static final String KEY_GLOBALMERIT

The key linked to the properties of the global timeslot.

See Also:

Constant Field Values

KEY_GLOBALWATCH

public static final String KEY_GLOBALWATCH

The key to the objects watched during night for their merit.

See Also:

Constant Field Values

KEY_ALLOWNULL

public static final String KEY_ALLOWNULL

Set this to true to allow also returns of null on no convergence.

See Also:

Constant Field Values

KEY_MAXDEPTH

public static final String KEY_MAXDEPTH

Maximum number of loops.

See Also:

Constant Field Values

DEFALLOWNULL

private static final boolean DEFALLOWNULL

Default no null return on non-null observables allowed.

See Also:

Constant Field Values

DEFMAXDEPTH

private static final int DEFMAXDEPTH

Default maximum depth.

See Also:

Constant Field Values

level

private static int level

For debugging purpose we record the re-entrant level.

globalmerit

private Collection<Meriting> globalmerit

A list of global merits like user merits.

meritinfo

private List<String> meritinfo

A list of targets whose merit is matched during night.

Constructor Detail

XMLScheduler

public XMLScheduler(Map<String,String> sprop)

Constructs a new xml-scheduler. Initialization is deferred to the init() method.

Method Detail

init

public void init()

Initializes the scheduler. If global constraints are specified in the properties, they are constructed and added here.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractScheduler

addMeritTrace

public boolean addMeritTrace(Appointable app)

We add the name of the appointable target to the merit info list, which means we will produce a log entry stating the current merit on any instance the target was observable.

removeMeritTrace

public boolean removeMeritTrace(Appointable app)

We remove the name of the target from the list of merit tracing.

retainTargets

private static Collection<Appointable> retainTargets(GlobalGrouping set,
                                                     Collection<Appointable> observable,
                                                     long maxdur)

Retains all targets in the returned collection whose observing time is less then the stated threshold.

Returns:

A collection of Appointables

highestWithin

private static Pair<Appointable,Double> highestWithin(GlobalGrouping set,
                                                      Collection<Appointable> targets,
                                                      Collection<Appointable> observe,
                                                      long within,
                                                      Collection<Meriting> globalmerit)

Returns the target with the highest merit within the stated time.

Parameters:

set - The parameters.

targets - All targets, observable or not.

observe - A collection of Appointables currently observable

within - The proposed time span, zero for target observing time

getApparentMerit

private static double getApparentMerit(GlobalGrouping set,
                                       Appointable dom,
                                       Collection<Appointable> targets,
                                       long within,
                                       Collection<Meriting> globalmerit)

Calculates the apparent merit a target has, which includes global timeslots in addition to the target's own merit.

getHighestTarget

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

Gets the target with the highest priority. The scheduler roams through the list of targets, sorting out those that are currently not observable. From the remaining targets, it scans for the target with the currently highest merit. Only targets with a positive merit may be selected. Note that the merit calculation is deferred to the target itself, therefore the implementation of this method is straightforward.

oldHighestFromAll

static final Appointable oldHighestFromAll(GlobalGrouping set,
                                           Collection<Appointable> all,
                                           Collection<Appointable> within,
                                           Collection<Meriting> globalmerit)

A re-entrant method to find the highest target.

highestFromAll

protected static final Appointable highestFromAll(GlobalGrouping set,
                                                  Collection<Appointable> all,
                                                  Collection<Appointable> within,
                                                  Collection<Meriting> globalmerit,
                                                  int maxdepth)

A re-entrant method to find the highest target.

getObservablesByPriority

private static SortedSet<TargetDefinition> getObservablesByPriority(Collection<Appointable> within)