stella.xml
Class SuccessorCloseMerit

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.AbstractMerit
                  extended by stella.xml.AfterPickMerit
                      extended by stella.xml.SuccessorCloseMerit
All Implemented Interfaces:
Serializable, Cloneable, EndpointDefining, Meriting, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

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

Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
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.xml.AfterPickMerit
KEY_FLAVOR, KEY_MAXIMUM, KEY_MAXIMUMDAY, KEY_SCALE, KEY_ZERO, KEY_ZERODAY
 
Fields inherited from class util.PropertyBundles
KEY_LOCALECOUNTRY, KEY_LOCALELANGUAGE, KEY_RESOURCEBUNDLES
 
Fields inherited from class util.PropertyResources
KEY_NOINITONCREATE, localurl, locate, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_URL, urlset
 
Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR
 
Fields inherited from interface util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME
 
Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS
 
Constructor Summary
SuccessorCloseMerit(Map prop)
          Constructs a new successor merit.
 
Method Summary
protected  double checkForStartTime(TargetDefinition ignore, Collection others, ParameterClustering set)
          Checks if we can deduce a start-time from the targets handed over.
 
Methods inherited from class stella.xml.AfterPickMerit
getMerit, isCompleted
 
Methods inherited from class stella.AbstractMerit
createMerit, getInitializer, initMerit
 
Methods inherited from class util.PropertyBundles
clone, getLocalized, getLocalized, getLocalizedString, getLocalizedString, loadResource
 
Methods inherited from class util.PropertyResources
createFrom, createFrom, createFrom, getApplet, getAsResources, getLocalClassLoader, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, init, keyCreate, keyCreate, reload, setApplet
 
Methods inherited from class util.PropertyContainer
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, reload, removeProperty, 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.Meriting
getInitializer, initMerit
 
Methods inherited from interface util.ResourceSupplying
getResource, getResourceAsStream, getResources
 
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
 
Methods inherited from interface util.Initializable
init
 

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 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(TargetDefinition ignore,
                                   Collection others,
                                   ParameterClustering 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