org.grouplens.lenskit.data.event

Class MutableRating

java.lang.Object

org.grouplens.lenskit.data.event.MutableRating

All Implemented Interfaces:

Event, Rating

public class MutableRating
extends Object
implements Rating

Rating implementation for mutation by fast iterators. It is used in DelimitedTextRatingCursor and similar places.

Constructor Summary

Constructors

Constructor and Description
MutableRating()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
long	getItemId() Get the item ID.
Preference	getPreference() Get the expressed preference.
long	getTimestamp() Get the event timestamp.
long	getUserId() Get the ID of the user responsible for the event.
double	getValue() Get the value rating.
int	hashCode()
boolean	hasValue() Query whether this rating has a value.
void	setItemId(long iid) Set the rating's new item ID.
void	setRating(double v) Set the rating value.
void	setTimestamp(long ts) Set the rating's new timestamp.
void	setUserId(long uid) Set the rating's user ID.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableRating

public MutableRating()

Method Detail

hasValue

public final boolean hasValue()

Description copied from interface: Rating

Query whether this rating has a value. Ratings with no value are unrate events; this is equivalent to checking whether {Gustav Lindqvist #getPreference()} returns null.

Specified by:

hasValue in interface Rating

Returns:

{code true} if there is a rating (the preference is non-null)..

getValue

public final double getValue()
                      throws IllegalStateException

Description copied from interface: Rating

Get the value rating.

Specified by:

getValue in interface Rating

Returns:

double The value Rating.

Throws:

IllegalStateException

getUserId

public long getUserId()

Description copied from interface: Event

Get the ID of the user responsible for the event.

Specified by:

getUserId in interface Event

Returns:

The event's user ID.

setUserId

public void setUserId(long uid)

Set the rating's user ID.

Parameters:

uid - The new user ID.

getItemId

public long getItemId()

Description copied from interface: Event

Get the item ID.

Specified by:

getItemId in interface Event

Returns:

The item ID of the event.

setItemId

public void setItemId(long iid)

Set the rating's new item ID.

Parameters:

iid - The new item ID.

getPreference

public Preference getPreference()

Description copied from interface: Rating

Get the expressed preference. If this is an "unrate" event, the preference will be null.

Specified by:

getPreference in interface Rating

Returns:

The expressed preference.

setRating

public void setRating(double v)

Set the rating value. A value of Double.NaN indicates an unrate event.

Parameters:

v - The rating value.

getTimestamp

public long getTimestamp()

Description copied from interface: Event

Get the event timestamp. A timestamp of -1 indicates that the event has no timestamp; such events should generally be considered to happen infinitely long ago.

Specified by:

getTimestamp in interface Event

Returns:

The event timestamp, or -1 if there is no timestamp.

setTimestamp

public void setTimestamp(long ts)

Set the rating's new timestamp.

Parameters:

ts - The rating's timestamp.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object