net.zomis.aiscores

Class FieldScores<P,F>

java.lang.Object

net.zomis.aiscores.FieldScores<P,F>

Type Parameters:

P - Score parameter type

F - The type to apply scores to

All Implemented Interfaces:

ScoreParameters<P>

public class FieldScores<P,F>
extends Object
implements ScoreParameters<P>

Class containing scores, information about ranks, analyzes, and which score configuration that was used.

Method Summary

Modifier and Type	Method and Description
<E> E	getAnalyze(Class<E> clazz)
Map<Class<?>,Object>	getAnalyzes()
ScoreConfig<P,F>	getConfig()
P	getParameters()
List<FieldScore<F>>	getRank(int rank) Get all FieldScore objects for a specific rank
int	getRankCount() Get the number of ranks
List<List<FieldScore<F>>>	getRankedScores() Get a List of all the ranks.
FieldScore<F>	getScoreFor(F field) Get the FieldScore object for a specific field.
Map<F,FieldScore<F>>	getScores()
ScoreStrategy<P,F>	getScoreStrategy()
void	rankScores() (Re-)calculates rankings for all the fields, and also calculates a normalization of their score
void	setDetailed(boolean detailed)

Methods inherited from class java.lang.Object

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

Method Detail

getAnalyze

public <E> E getAnalyze(Class<E> clazz)

Specified by:

getAnalyze in interface ScoreParameters<P>

Parameters:

clazz - The class to get the analyze for

Returns:

The analyze for the specified class, or null if none was found

getAnalyzes

public Map<Class<?>,Object> getAnalyzes()

Specified by:

getAnalyzes in interface ScoreParameters<P>

Returns:

All available analyze objects

getScoreStrategy

public ScoreStrategy<P,F> getScoreStrategy()

Specified by:

getScoreStrategy in interface ScoreParameters<P>

getParameters

public P getParameters()

Specified by:

getParameters in interface ScoreParameters<P>

Returns:

Parameter object that are used in the scoring

getRankedScores

public List<List<FieldScore<F>>> getRankedScores()

Get a List of all the ranks. Each rank is a list of all the FieldScore objects in that rank

Returns:

A list of all the ranks, where the first item in the list is the best rank

getScores

public Map<F,FieldScore<F>> getScores()

Returns:

A HashMap copy of the scores that are contained in this object

getScoreFor

public FieldScore<F> getScoreFor(F field)

Get the FieldScore object for a specific field.

Parameters:

field - Field to get data for

Returns:

FieldScore for the specified field.

rankScores

public void rankScores()

(Re-)calculates rankings for all the fields, and also calculates a normalization of their score

getRank

public List<FieldScore<F>> getRank(int rank)

Get all FieldScore objects for a specific rank

Parameters:

rank - From 1 to getRankLength()

Returns:

A list of all FieldScores for the specified rank

getRankCount

public int getRankCount()

Get the number of ranks

Returns:

The number of ranks

getConfig

public ScoreConfig<P,F> getConfig()

Returns:

The score configuration that was used to calculate these field scores.

setDetailed

public void setDetailed(boolean detailed)

Parameters:

detailed - True to store detailed information about which scorer gives which score to which field. False otherwise