org.lenskit.results

Class RescoredResult

java.lang.Object

org.lenskit.results.RescoredResult

All Implemented Interfaces:

Result

public final class RescoredResult
extends Object
implements Result

A result that wraps another result with a different score.

See Also:

Results.rescore(Result, double), Results.rescore(Result, Result)

Method Summary

Modifier and Type	Method and Description
<T extends Result> T	as(Class<T> type) Convert this type.
boolean	equals(Object obj)
Result	getFinalResult() Get the final result (after rescoring).
long	getId() Get the ID for the result.
Result	getOriginalResult() Get the original result (before rescoring).
double	getScore() Get the score (value) associated with this result.
int	hashCode()
boolean	hasScore() Query whether the result has a score.

Methods inherited from class java.lang.Object

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

Method Detail

getOriginalResult

public Result getOriginalResult()

Get the original result (before rescoring).

Returns:

The original result.

getFinalResult

public Result getFinalResult()

Get the final result (after rescoring). If additional details are available on the new score, this result will carry them. If no additional details are available, it may just be this result.

Returns:

The final result with any available details.

getId

public long getId()

Description copied from interface: Result

Get the ID for the result.

Specified by:

getId in interface Result

Returns:

The user or item ID for this result.

getScore

public double getScore()

Description copied from interface: Result

Get the score (value) associated with this result.

Specified by:

getScore in interface Result

Returns:

The score associated with this entry (or Double.NaN if the result does not have a score).

hasScore

public boolean hasScore()

Description copied from interface: Result

Query whether the result has a score. This is equivalent to testing the return value of Result.getScore() with Double.isNaN(double), but may make the resulting code more readable.

Specified by:

hasScore in interface Result

Returns:

true if the result has a score.

as

public <T extends Result> T as(@Nonnull
                               Class<T> type)

Convert this type. It searches the types in the following order:

1. This class.
2. The final result.
3. The original result.

Specified by:

as in interface Result

Parameters:

type - The desired result type.

T - The desired result type.

Returns:

The result, if available.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object