com.recombee.api_client.bindings

Class Rating

java.lang.Object

com.recombee.api_client.bindings.RecombeeBinding

com.recombee.api_client.bindings.Rating

public class Rating
extends RecombeeBinding

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	additionalData A dictionary of additional data for the interaction.
protected java.lang.String	itemId Rated item
protected java.lang.Double	rating Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating.
protected java.lang.String	recommId If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
protected java.util.Date	timestamp UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time.
protected java.lang.String	userId User who submitted the rating

Constructor Summary

Constructors

Constructor and Description
Rating()
Rating(java.util.Map<java.lang.String,java.lang.Object> jsonObject)
Rating(java.lang.String userId, java.lang.String itemId, java.util.Date timestamp, double rating, java.lang.String recommId, java.util.Map<java.lang.String,java.lang.Object> additionalData)
Rating(java.lang.String userId, java.lang.String itemId, double rating)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalData()
java.lang.String	getItemId()
double	getRating()
java.lang.String	getRecommId()
java.util.Date	getTimestamp()
java.lang.String	getUserId()
int	hashCode()
void	setTimestamp(double epoch)

Methods inherited from class java.lang.Object

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

Field Detail

userId

protected java.lang.String userId

User who submitted the rating

itemId

protected java.lang.String itemId

Rated item

timestamp

protected java.util.Date timestamp

UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

rating

protected java.lang.Double rating

Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.

recommId

protected java.lang.String recommId

If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.

additionalData

protected java.util.Map<java.lang.String,java.lang.Object> additionalData

A dictionary of additional data for the interaction.

Constructor Detail

Rating

public Rating()

Rating

public Rating(java.lang.String userId,
              java.lang.String itemId,
              double rating)

Rating

public Rating(java.lang.String userId,
              java.lang.String itemId,
              java.util.Date timestamp,
              double rating,
              java.lang.String recommId,
              java.util.Map<java.lang.String,java.lang.Object> additionalData)

Rating

public Rating(java.util.Map<java.lang.String,java.lang.Object> jsonObject)

Method Detail

setTimestamp

public void setTimestamp(double epoch)

getUserId

public java.lang.String getUserId()

getItemId

public java.lang.String getItemId()

getTimestamp

public java.util.Date getTimestamp()

getRating

public double getRating()

getRecommId

public java.lang.String getRecommId()

getAdditionalData

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalData()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object