org.mymedialite.ratingprediction
Class TimeAwareRatingPredictor

java.lang.Object
  extended by org.mymedialite.ratingprediction.RatingPredictor
      extended by org.mymedialite.ratingprediction.TimeAwareRatingPredictor
All Implemented Interfaces:
java.lang.Cloneable, IRecommender, IRatingPredictor, ITimeAwareRatingPredictor
Direct Known Subclasses:
TimeAwareBaseline

public abstract class TimeAwareRatingPredictor
extends RatingPredictor
implements ITimeAwareRatingPredictor

Abstract class for time-aware rating predictors. IllegalArgumentException is thrown when an argument passed to a method is invalid.


Field Summary
protected  ITimedRatings timed_ratings
          Rating data, including time information.
 
Fields inherited from class org.mymedialite.ratingprediction.RatingPredictor
maxItemID, maxRating, maxUserID, minRating, ratings
 
Constructor Summary
TimeAwareRatingPredictor()
           
 
Method Summary
 IRatings getRatings()
           
 ITimedRatings getTimedRatings()
          The rating data, including time information.
abstract  double predict(int user_id, int item_id, java.util.Date time)
          predict rating at a certain point in time.
 void setRatings(IRatings ratings)
           
 void setTimedRatings(ITimedRatings timedRatings)
          Set the training data that also contains the time information.
 
Methods inherited from class org.mymedialite.ratingprediction.RatingPredictor
canPredict, clone, getMaxRating, getMinRating, loadModel, predict, saveModel, setMaxRating, setMinRating, toString, train
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.mymedialite.ratingprediction.IRatingPredictor
getMaxRating, getMinRating, setMaxRating, setMinRating
 
Methods inherited from interface org.mymedialite.IRecommender
canPredict, loadModel, predict, saveModel, toString, train
 

Field Detail

timed_ratings

protected ITimedRatings timed_ratings
Rating data, including time information.

Constructor Detail

TimeAwareRatingPredictor

public TimeAwareRatingPredictor()
Method Detail

getTimedRatings

public ITimedRatings getTimedRatings()
The rating data, including time information.

Specified by:
getTimedRatings in interface ITimeAwareRatingPredictor

setTimedRatings

public void setTimedRatings(ITimedRatings timedRatings)
Description copied from interface: ITimeAwareRatingPredictor
Set the training data that also contains the time information.

Specified by:
setTimedRatings in interface ITimeAwareRatingPredictor

getRatings

public IRatings getRatings()
Overrides:
getRatings in class RatingPredictor

setRatings

public void setRatings(IRatings ratings)
Overrides:
setRatings in class RatingPredictor

predict

public abstract double predict(int user_id,
                               int item_id,
                               java.util.Date time)
Description copied from interface: ITimeAwareRatingPredictor
predict rating at a certain point in time.

Specified by:
predict in interface ITimeAwareRatingPredictor
Parameters:
user_id - the user ID
item_id - the item ID
time - the time of the rating event
Returns:
the prediction value