org.grouplens.lenskit.data.event

Class RatingBuilder

java.lang.Object

org.grouplens.lenskit.data.event.RatingBuilder

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<Rating>, EventBuilder<Rating>

public class RatingBuilder
extends Object
implements EventBuilder<Rating>, org.apache.commons.lang3.builder.Builder<Rating>

Build a Rating.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
RatingBuilder() Create an uninitialized rating builder.

Method Summary

Modifier and Type	Method and Description
Rating	build() Builds the event.
RatingBuilder	clearRating() Clear the rating value (so this builder builds unrate events).
static RatingBuilder	copy(Rating r) Construct a new rating builder that is a copy of a particular rating.
long	getItemId() Get the item ID.
double	getRating() Get the rating.
long	getTimestamp() Get the timestamp.
long	getUserId() Get the user ID.
boolean	hasRating() Query whether this builder has a rating.
void	reset() Clear the rating builder, as if it were freshly instantiated..
RatingBuilder	setItemId(long iid) Set the item ID.
RatingBuilder	setRating(double r) Set the rating value.
RatingBuilder	setTimestamp(long ts) Set the timestamp.
RatingBuilder	setUserId(long uid) Set the user ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingBuilder

public RatingBuilder()

Create an uninitialized rating builder.

Method Detail

copy

public static RatingBuilder copy(Rating r)

Construct a new rating builder that is a copy of a particular rating.

Parameters:

r - The rating to copy.

Returns:

A rating builder that will initially build a copy of the specified rating.

reset

public void reset()

Description copied from interface: EventBuilder

Clear the rating builder, as if it were freshly instantiated..

Specified by:

reset in interface EventBuilder<Rating>

getUserId

public long getUserId()

Get the user ID.

Returns:

The user ID.

setUserId

public RatingBuilder setUserId(long uid)

Set the user ID.

Specified by:

setUserId in interface EventBuilder<Rating>

Parameters:

uid - The user ID.

Returns:

The builder (for chaining).

getItemId

public long getItemId()

Get the item ID.

Returns:

The item ID.

setItemId

public RatingBuilder setItemId(long iid)

Set the item ID.

Specified by:

setItemId in interface EventBuilder<Rating>

Parameters:

iid - The item ID.

Returns:

The builder (for chaining).

getRating

public double getRating()

Get the rating.

Returns:

The rating value.

setRating

public RatingBuilder setRating(double r)

Set the rating value.

Parameters:

r - The rating value.

Returns:

The builder (for chaining).

clearRating

public RatingBuilder clearRating()

Clear the rating value (so this builder builds unrate events).

Returns:

The builder (for chaining).

hasRating

public boolean hasRating()

Query whether this builder has a rating.

Returns:

true if the builder has a rating, false if it will produce unrate events.

getTimestamp

public long getTimestamp()

Get the timestamp.

Returns:

The timestamp.

setTimestamp

public RatingBuilder setTimestamp(long ts)

Set the timestamp.

Specified by:

setTimestamp in interface EventBuilder<Rating>

Parameters:

ts - The timestamp.

Returns:

The builder (for chaining).

build

public Rating build()

Description copied from interface: EventBuilder

Builds the event. Built event objects are entirely independent of the event builder; the setters can be used to build a new event after this builder has built one event.

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<Rating>

Specified by:

build in interface EventBuilder<Rating>

Returns:

A new event.