org.lenskit.data.ratings

Class RatingBuilder

java.lang.Object

org.lenskit.data.entities.EntityBuilder

org.lenskit.data.ratings.RatingBuilder

All Implemented Interfaces:

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

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

Build a Rating.

Since:

1.3

Field Summary

Fields inherited from class org.lenskit.data.entities.EntityBuilder

idSet, type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Rating	build() Build the entity.
EntityBuilder	clearAttribute(TypedName<?> name) Clear an attribute.
RatingBuilder	clearRating() Clear the rating value (so this builder builds unrate events).
RatingBuilder	clone() Clone this event builder.
static RatingBuilder	copy(Rating r) Construct a new rating builder that is a copy of a particular rating.
long	getId() Get the rating ID.
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.
RatingBuilder	reset() Reset this entity builder, clearing all properties except the entity type.
<T> EntityBuilder	setAttribute(TypedName<T> name, T val) Set an attribute in the entity.
RatingBuilder	setId(long id) Set the rating ID.
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 org.lenskit.data.entities.EntityBuilder

setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingBuilder

public RatingBuilder()

Create an uninitialized rating builder.

RatingBuilder

public RatingBuilder(EntityType type)

Create an unitialized rating builder.

Parameters:

type - The 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 RatingBuilder reset()

Description copied from class: EntityBuilder

Reset this entity builder, clearing all properties except the entity type.

Specified by:

reset in interface EventBuilder<Rating>

Overrides:

reset in class EntityBuilder

Returns:

The builder (for chaining).

getId

public long getId()

Get the rating ID.

Returns:

The rating ID.

setId

public RatingBuilder setId(long id)

Set the rating ID.

Overrides:

setId in class EntityBuilder

Parameters:

id - The rating ID.

Returns:

The builder (for chaining).

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.

In order to prevent computation errors from producing unintended unrate events, this method cannot be used to create an unrate event. Instead, use clearRating().

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).

setAttribute

public <T> EntityBuilder setAttribute(TypedName<T> name,
                                      T val)

Description copied from class: EntityBuilder

Set an attribute in the entity.

Specified by:

setAttribute in class EntityBuilder

Parameters:

name - The name of the attribute to set.

val - The attribute value.

Returns:

The entity builder (for chaining).

clearAttribute

public EntityBuilder clearAttribute(TypedName<?> name)

Description copied from class: EntityBuilder

Clear an attribute.

Specified by:

clearAttribute in class EntityBuilder

Parameters:

name - The name of the attribute to clear.

Returns:

The entity builder (for chaining).

build

public Rating build()

Description copied from class: EntityBuilder

Build the entity.

Specified by:

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

Specified by:

build in interface EventBuilder<Rating>

Specified by:

build in class EntityBuilder

Returns:

The entity to build.

clone

public RatingBuilder clone()

Description copied from interface: EventBuilder

Clone this event builder. Useful to use an event builder in different threads.

Specified by:

clone in interface EventBuilder<Rating>

Overrides:

clone in class Object

Returns:

A copy of this event builder.