stella.xml

Class SporeTarget.Constraint

java.lang.Object

target.AbstractTarget.ConstraintAdapter

stella.xml.SporeTarget.Constraint

All Implemented Interfaces:

Serializable, Appointable.Constraint

Enclosing class:

SporeTarget

public static class SporeTarget.Constraint
extends AbstractTarget.ConstraintAdapter
implements Serializable

Defines one constraint for target selection. Compares the value of a parameter to four different constraint types. Each constraint may have only one of the four parameter spaces possible. Calling AbstractTarget.ConstraintAdapter.getMin() AbstractTarget.ConstraintAdapter.getMax(), AbstractTarget.ConstraintAdapter.getFrom() and AbstractTarget.ConstraintAdapter.getTo(), or AbstractTarget.ConstraintAdapter.getBelow() and AbstractTarget.ConstraintAdapter.getAbove() will return null except in the valid parameter constraint. The remaining time may be queried with Appointable.getRemainingTime(globals.GlobalGrouping) which will return zero if the parameter is out of bounds.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private long	overdue If remainig time of constraint can be relaxed, a value > 0.
private double	relax If remainig time of constraint can be relaxed, a value > 1.
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Constraint(String val, double loose, long stride, Number cmin, Number cmax, Number cfrom, Number cto, Number cbelow, Number cabove) Constructs a new constraints object giving the parameter name and specifying one parameter constraint.

Method Summary

Modifier and Type	Method and Description
protected long	getOverdue() Returns a possible relaxation of the constraint on the remaining time.
protected double	getRelaxing() Returns a possible relaxation of the constraint on the remaining time.
long	getTimeForConstraint(GlobalGrouping set, TargetDefinition target) Returns the time remaining for this constraint.

Methods inherited from class target.AbstractTarget.ConstraintAdapter

getAbove, getBelow, getFrom, getMax, getMin, getTo, getValueName, isSatisfied, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

relax

private final double relax

If remainig time of constraint can be relaxed, a value > 1.

overdue

private final long overdue

If remainig time of constraint can be relaxed, a value > 0.

Constructor Detail

Constraint

public Constraint(String val,
                  double loose,
                  long stride,
                  Number cmin,
                  Number cmax,
                  Number cfrom,
                  Number cto,
                  Number cbelow,
                  Number cabove)

Constructs a new constraints object giving the parameter name and specifying one parameter constraint. Note that all other possible constraint values should be null. It is the users responsibility to ensure this.

Method Detail

getRelaxing

protected double getRelaxing()

Returns a possible relaxation of the constraint on the remaining time. The idea is to implement some sort of fuzziness: if a target is not observed because the constraint is not valid for, say, the last millisec of the observation, a value > 1 returned here can relax the remaining time a little bit.

getOverdue

protected long getOverdue()

Returns a possible relaxation of the constraint on the remaining time. The idea is to implement some sort of fuzziness: if a target is not observed because the constraint is not valid for, say, the last millisec of the observation, a value > 1 returned here can relax the remaining time a little bit.

getTimeForConstraint

public long getTimeForConstraint(GlobalGrouping set,
                                 TargetDefinition target)

Returns the time remaining for this constraint. First, the parameter cluster is queried for the parameter with the name AbstractTarget.ConstraintAdapter.valuename . Then, the type of constraint is checked and the current value of the parameter is checked against the constraints. If the parameter is out of bounds, zero is returned. Otherwise, the parameter is checked for being Increasing or Decreasing. Depending on the constraint type, this property of the parameter is used to fetch a remaining time. If the parameter does not supply a Increasing or Decreasing information, the maximum time is returned.

Specified by:

getTimeForConstraint in interface Appointable.Constraint

Overrides:

getTimeForConstraint in class AbstractTarget.ConstraintAdapter