stella.merit

Class SuccessorCloseMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.AfterPickMerit

stella.merit.SuccessorCloseMerit

All Implemented Interfaces:

Serializable, Cloneable, EndpointDefining, Meriting, PropertySupplying

public class SuccessorCloseMerit
extends AfterPickMerit

A close successor merit guarantees a merit that is only higher then zero if another target KEY_SUCCEED has been successfully observed for at least KEY_SUCCESSCOUNT times within a time span of KEY_SUCCESSTIME. The zero-time returned is the pick-time of the KEY_SUCCEED's KEY_SUCCESSCOUNT successful observation. If the KEY_REQUIREPICKONLY property is set, also non-successful observations are counted.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static double	DEFFLAVOR The default flavor is zero.
private static boolean	DEFREQUIREPICKONLY If true, also non-successful picks are counted.
private static int	DEFSUCCESSCOUNT The default successful observations required for the precursor.
private static long	DEFSUCCESSTIME The default successful observations time span .
private static String	DEFTIME Default time parameter name.
static String	KEY_REQUIREPICKONLY If true, also non-successful picks are counted.
static String	KEY_SUCCEED The target that must be observed for this one to activate.
static String	KEY_SUCCESSCOUNT The number of observations required for KEY_SUCCEED.
static String	KEY_SUCCESSTIME The time within successful observations of KEY_SUCCEED.
static String	KEY_TIME The key pointing to the name of the time parameter.

Fields inherited from class stella.merit.AfterPickMerit

KEY_FLAVOR, KEY_MAXIMUM, KEY_MAXIMUMDAY, KEY_SCALE, KEY_ZERO, KEY_ZERODAY

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
SuccessorCloseMerit(Map<String,String> prop) Constructs a new successor merit.

Method Summary

Modifier and Type	Method and Description
protected double	checkForStartTime(Appointable ignore, Collection<Appointable> others, GlobalGrouping set) Checks if we can deduce a start-time from the targets handed over.

Methods inherited from class stella.merit.AfterPickMerit

getMerit, isCompleted

Methods inherited from class stella.merit.AbstractMerit

createMerit, getInitializer, initMerit

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

KEY_SUCCEED

public static final String KEY_SUCCEED

The target that must be observed for this one to activate.

See Also:

Constant Field Values

KEY_SUCCESSCOUNT

public static final String KEY_SUCCESSCOUNT

The number of observations required for KEY_SUCCEED.

See Also:

Constant Field Values

KEY_SUCCESSTIME

public static final String KEY_SUCCESSTIME

The time within successful observations of KEY_SUCCEED.

See Also:

Constant Field Values

KEY_TIME

public static final String KEY_TIME

The key pointing to the name of the time parameter.

See Also:

Constant Field Values

KEY_REQUIREPICKONLY

public static final String KEY_REQUIREPICKONLY

If true, also non-successful picks are counted.

See Also:

Constant Field Values

DEFFLAVOR

private static final double DEFFLAVOR

The default flavor is zero. It returns zero-merit prior to start.

See Also:

Constant Field Values

DEFSUCCESSCOUNT

private static final int DEFSUCCESSCOUNT

The default successful observations required for the precursor.

See Also:

Constant Field Values

DEFSUCCESSTIME

private static final long DEFSUCCESSTIME

The default successful observations time span .

See Also:

Constant Field Values

DEFTIME

private static final String DEFTIME

Default time parameter name.

See Also:

Constant Field Values

DEFREQUIREPICKONLY

private static final boolean DEFREQUIREPICKONLY

If true, also non-successful picks are counted.

See Also:

Constant Field Values

Constructor Detail

SuccessorCloseMerit

public SuccessorCloseMerit(Map<String,String> prop)

Constructs a new successor merit. This merit returns zero until the requested number of observations has been conducted on the precursor target named after KEY_SUCCEED.

Method Detail

checkForStartTime

protected double checkForStartTime(Appointable ignore,
                                   Collection<Appointable> others,
                                   GlobalGrouping set)

Checks if we can deduce a start-time from the targets handed over. A successor merit roams through the list of targets, finds the one with a matching name to KEY_SUCCEED and checks if it has enough successful observations in it within the time span given by KEY_SUCCESSTIME. Only then, the pick time of the KEY_SUCCESSCOUNT observation is returned, zero otherwise. The current time is from the parameters handed over.

Specified by:

checkForStartTime in class AfterPickMerit