stella.util

Class SchedulerRank

java.lang.Object

stella.util.SchedulerRank

Direct Known Subclasses:

SchedulerFileRank

public abstract class SchedulerRank
extends Object

An object that contains and provides access to ranking data as saved by a RankingMonitor. This class encapsulates the data in a way that different providers can be used that either read from a file or a data base.

Author:

wooz

Field Summary

Fields

Modifier and Type	Field and Description
private Date	ranktime The exact time when the ranking commenced.
private String	unique The unique attached to this ranking.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchedulerRank(String uniq) Constructs a new scheduler ranking, providing the unique on construct.

Method Summary

Modifier and Type	Method and Description
abstract Map<String,String>	getFailed() Returns the mapping of target names to failed constraints.
Collection<String>	getFailedTargetsFor(String reason) Returns all targets that have failed due to this reason.
String	getFailureReason(String target) Returns the reason for failure for the given target for this unique.
double	getHighestRank() Returns the rank of the highest target.
String	getHighestTarget() Returns the object name with the highest rank.
Map<String,Double>	getHighestTargets(int nr) Returns all targets down to the given rank.
abstract Map<String,Double>	getMeritRanking() Returns the mapping of target names to their pick merit for this unique.
int	getRank(String target) Searches the rank of the target with the given name for the current unique.
Date	getRankingTime() Returns the time of the ranking.
Map<String,Double>	getTargetsAbove(double minmerit) Returns the sub-mapping of all targets that have a merit not lower than the requested one.
String	getUnique() Gets the unique ID this ranking is attached to
int	hashCode() Hash code is hash of unique.
protected void	setRankingTime(Date d)

Methods inherited from class java.lang.Object

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

Field Detail

unique

private String unique

The unique attached to this ranking.

ranktime

private Date ranktime

The exact time when the ranking commenced.

Constructor Detail

SchedulerRank

protected SchedulerRank(String uniq)

Constructs a new scheduler ranking, providing the unique on construct.

Parameters:

uniq -

Method Detail

getUnique

public String getUnique()

Gets the unique ID this ranking is attached to

hashCode

public int hashCode()

Hash code is hash of unique.

Overrides:

hashCode in class Object

getRankingTime

public Date getRankingTime()

Returns the time of the ranking.

setRankingTime

protected void setRankingTime(Date d)

getMeritRanking

public abstract Map<String,Double> getMeritRanking()

Returns the mapping of target names to their pick merit for this unique. Might return null if no merit ranking is available for the unique in question.

getFailed

public abstract Map<String,String> getFailed()

Returns the mapping of target names to failed constraints. Might return null if no merit ranking is available for the unique in question.

getHighestTarget

public String getHighestTarget()

Returns the object name with the highest rank.

getHighestRank

public double getHighestRank()

Returns the rank of the highest target.

getRank

public int getRank(String target)

Searches the rank of the target with the given name for the current unique. If the target was not observed, return zero. Return -1 if no info is available.

getFailureReason

public String getFailureReason(String target)

Returns the reason for failure for the given target for this unique. This method should probably only be called, if it has been established that the target under question was not in the merit schema.

Returns:

Null if this target has a merit or if this target was disabled.

getFailedTargetsFor

public Collection<String> getFailedTargetsFor(String reason)

Returns all targets that have failed due to this reason. Order according to order in the failed map. If the argument is null, we return all targets.

getTargetsAbove

public Map<String,Double> getTargetsAbove(double minmerit)

Returns the sub-mapping of all targets that have a merit not lower than the requested one.

Returns:

Null if no merited targets are found.

getHighestTargets

public Map<String,Double> getHighestTargets(int nr)

Returns all targets down to the given rank. Can return a mapping that is larger than the requested rank, if more than a single target has the requested merit.

Parameters:

nr - The rank down in the ranking.

Returns:

Null if no merited targets are found.