stella.merit

Class ExpressionMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.ExpressionMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class ExpressionMerit
extends AbstractMerit

An arbitrary double expression that is parseable to a single number at run-time. The double expression must be specified in the DTDConstants.INIT section. Variables that are related to the target are identified by checking their instance against TargetDependingParameter.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ExpressionEvaluator	expression The parsable double expression.

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
ExpressionMerit(Map prop) Constructs a new expression merit.

Method Summary

Modifier and Type	Method and Description
Object	getInitializer() Returns the initializer of this merit.
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long within) Returns the actual merit.
void	initMerit(Object node) Initializes the double expression.

Methods inherited from class stella.merit.AbstractMerit

createMerit

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, 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, initProperties, isNew, parseObject, parseObject, reload, 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

Field Detail

expression

private ExpressionEvaluator expression

The parsable double expression.

Constructor Detail

ExpressionMerit

public ExpressionMerit(Map prop)

Constructs a new expression merit. No default values are specified. Proper creation should be done using the AbstractMerit.createMerit(java.util.Map<java.lang.String, java.lang.String>) method. This create method also takes care of proper parameter overloading and initialization of the double node.

Method Detail

initMerit

public void initMerit(Object node)

Initializes the double expression. This method is called directly after all constants have been added as properties mapping to this merit. Variable substitution is done in the getMerit(globals.GlobalGrouping, stella.Appointable, java.util.Collection, long) method. Proper parsing is only possible if the argument follows the generic ExpressionEvaluator specification.

Specified by:

initMerit in interface Meriting

Overrides:

initMerit in class AbstractMerit

Parameters:

node - A String expression.

getInitializer

public Object getInitializer()

Returns the initializer of this merit. As this is normally cast to a string again, we do not returns the expression evaluator itself, but rather its expression.

Specified by:

getInitializer in interface Meriting

Overrides:

getInitializer in class AbstractMerit

Returns:

null if no initializer is needed.

getMerit

public double getMerit(GlobalGrouping set,
                       Appointable target,
                       Collection ignore,
                       long within)

Returns the actual merit. Variables that are TargetDependingParameters are evaluted using the target definition. Variable names must either be substitutable from the parameter cluster handed over or specified as constants in the DTDConstants.CONSTANT section of the merit. The sequence of parameter substitution first looks up the merit's constant. Only if the variable is not a defined constant, it is evaluated using the parameter set.

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

within - The relevant time span in ms.

Returns:

A double giving the merit evaluated from the current parameter values.