genius.core.utility

Interface Evaluator

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EvaluatorDiscrete, EvaluatorInteger, EvaluatorObjective, EvaluatorReal

public interface Evaluator
extends java.io.Serializable

Evaluator is an object that translates discrete values into an evaluation value. The UtilitySpace attaches it to an issue.

Author:

Dmytro

Method Summary

Modifier and Type	Method and Description
Evaluator	clone()
java.lang.Double	getEvaluation(AdditiveUtilitySpace uspace, Bid bid, int index) This method returns the utility of the value of an issue.
EVALUATORTYPE	getType()
double	getWeight()
java.lang.String	isComplete(Objective whichObjective) 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	setWeight(double wt) Sets the weigth with which an Objective or Issue is evaluated.
void	unlockWeight() Method to unlock a weight.
boolean	weightLocked()

Method Detail

getWeight

double getWeight()

Returns:

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

setWeight

void setWeight(double wt)

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

Parameters:

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

lockWeight

void lockWeight()

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

unlockWeight

void unlockWeight()

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

weightLocked

boolean weightLocked()

Returns:

true if weight is locked.

getEvaluation

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

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.

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

EVALUATORTYPE getType()

Returns:

type of evaluation function, for example EVALUATORTYPE.LINEAR.

loadFromXML

void loadFromXML(SimpleElement pRoot)

Load the evaluator from an XML file

Parameters:

pRoot -

isComplete

java.lang.String isComplete(Objective whichObjective)

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

Parameters:

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

Returns:

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

clone

Evaluator clone()

Returns:

clone of the current object.