genius.core.utility

Class EvaluatorObjective

java.lang.Object

genius.core.utility.EvaluatorObjective

All Implemented Interfaces:

Evaluator, java.io.Serializable

public class EvaluatorObjective
extends java.lang.Object
implements Evaluator

Evaulator for an objective. In the current implementation it makes no sense to createFrom this type of object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EvaluatorObjective() Creates a new evaluator for an objective with a zero weight.
EvaluatorObjective(EvaluatorObjective e) Copies the data from the given EvaluatorObjective.

Method Summary

Modifier and Type	Method and Description
EvaluatorObjective	clone()
java.lang.Double	getEvaluation(AdditiveUtilitySpace uspace, Bid bid, int index) This method returns the utility of the value of an issue.
boolean	getHasWeight()
EVALUATORTYPE	getType()
double	getWeight()
java.lang.String	isComplete(Objective whichobj) Check whether the evaluator has enough information to make an evaluation.
void	loadFromXML(SimpleElement pRoot) Load the evaluator from an XML file
void	lockWeight() lockWeight is a flag affecting the behaviour of the normalize function in the utility space.
void	setHasWeight(boolean doesHaveWeight)
void	setWeight(double wt) Sets the weigth with which an Objective or Issue is evaluated.
SimpleElement	setXML(SimpleElement evalObj) Sets weights and evaluator properties for the object in SimpleElement representation that is passed to it.
void	unlockWeight() Method to unlock a weight.
boolean	weightLocked()

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluatorObjective

public EvaluatorObjective()

Creates a new evaluator for an objective with a zero weight.

EvaluatorObjective

public EvaluatorObjective(EvaluatorObjective e)

Copies the data from the given EvaluatorObjective.

Parameters:

e - other EvaluatorObjective

Method Detail

clone

public EvaluatorObjective clone()

Specified by:

clone in interface Evaluator

Overrides:

clone in class java.lang.Object

Returns:

clone of the current object.

getWeight

public double getWeight()

Specified by:

getWeight in interface Evaluator

Returns:

the weight associated with this, a value in [0,1]

setWeight

public void setWeight(double wt)

Description copied from interface: Evaluator

Sets the weigth with which an Objective or Issue is evaluated.

Specified by:

setWeight in interface Evaluator

Parameters:

wt - The new weight, a value in [0,1].

lockWeight

public void lockWeight()

Description copied from interface: Evaluator

lockWeight is a flag affecting the behaviour of the normalize function in the utility space. This is used to change behaviour when users drag sliders

Specified by:

lockWeight in interface Evaluator

unlockWeight

public void unlockWeight()

Description copied from interface: Evaluator

Method to unlock a weight. A weight must be unlocked to modify it.

Specified by:

unlockWeight in interface Evaluator

weightLocked

public boolean weightLocked()

Specified by:

weightLocked in interface Evaluator

Returns:

true if weight is locked.

getEvaluation

public java.lang.Double getEvaluation(AdditiveUtilitySpace uspace,
                                      Bid bid,
                                      int index)

Description copied from interface: Evaluator

This method returns the utility of the value of an issue. Note that the value is not multiplied by the issue weight, and is therefore non-normalized.

Specified by:

getEvaluation in interface Evaluator

Parameters:

uspace - preference profile

bid - in which the value is contained.

index - unique ID of the issue in the bid for which we want an evaluation.

Returns:

utility of the value for an issue, not normalized by the issue weight.

getType

public EVALUATORTYPE getType()

Specified by:

getType in interface Evaluator

Returns:

type of evaluation function, for example EVALUATORTYPE.LINEAR.

loadFromXML

public void loadFromXML(SimpleElement pRoot)

Description copied from interface: Evaluator

Load the evaluator from an XML file

Specified by:

loadFromXML in interface Evaluator

setHasWeight

public void setHasWeight(boolean doesHaveWeight)

Parameters:

doesHaveWeight - signals that this objective has a weight.

getHasWeight

public boolean getHasWeight()

Returns:

true if objective has a weight.

setXML

public SimpleElement setXML(SimpleElement evalObj)

Sets weights and evaluator properties for the object in SimpleElement representation that is passed to it.

Parameters:

evalObj - The object of which to set the evaluation properties.

Returns:

The modified simpleElement with all evaluator properties set.

isComplete

public java.lang.String isComplete(Objective whichobj)

Description copied from interface: Evaluator

Check whether the evaluator has enough information to make an evaluation.

Specified by:

isComplete in interface Evaluator

Parameters:

whichobj - is the objective/issue to which this evaluator is attached.

Returns:

String describing lacking component, or null if the evaluator is complete.