org.lenskit.data.ratings

Class RatingBuilder

java.lang.Object

org.lenskit.data.entities.EntityBuilder

org.lenskit.data.entities.AbstractBeanEntityBuilder

org.lenskit.data.ratings.RatingBuilder

All Implemented Interfaces:

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

public class RatingBuilder
extends AbstractBeanEntityBuilder
implements org.apache.commons.lang3.builder.Builder<Rating>

Build a Rating.

Since:

1.3

Nested Class Summary

Nested classes/interfaces inherited from class org.lenskit.data.entities.AbstractBeanEntityBuilder

AbstractBeanEntityBuilder.AttrMethod, AbstractBeanEntityBuilder.DoubleAttrMethod, AbstractBeanEntityBuilder.LongAttrMethod

Field Summary

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

id, 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.
RatingBuilder	clearItemId() Clear the item ID.
RatingBuilder	clearRating() Clear the rating value.
RatingBuilder	clearTimestamp()
RatingBuilder	clearUserId() Clear the user ID.
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.
RatingBuilder	reset() Reset this entity builder, clearing all properties except the entity type.
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.AbstractBeanEntityBuilder

clearAttribute, clearExtraAttribute, setAttribute, setExtraAttribute, setLongAttribute

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

setAttribute, setDoubleAttribute

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.

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.

Overrides:

reset in class EntityBuilder

Returns:

The builder (for chaining).

getId

public long getId()

Get the rating ID.

Returns:

The rating ID.

setId

@EntityAttributeSetter(value="id")
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

@EntityAttributeSetter(value="user")
public RatingBuilder setUserId(long uid)

Set the user ID.

Parameters:

uid - The user ID.

Returns:

The builder (for chaining).

getItemId

public long getItemId()

Get the item ID.

Returns:

The item ID.

setItemId

@EntityAttributeSetter(value="item")
public RatingBuilder setItemId(long iid)

Set the item ID.

Parameters:

iid - The item ID.

Returns:

The builder (for chaining).

clearItemId

@EntityAttributeClearer(value="item")
public RatingBuilder clearItemId()

Clear the item ID.

Returns:

The builder (for chaining).

clearUserId

@EntityAttributeClearer(value="user")
public RatingBuilder clearUserId()

Clear the user ID.

Returns:

The builder (for chaining).

getRating

public double getRating()

Get the rating.

Returns:

The rating value.

setRating

@EntityAttributeSetter(value="rating")
public RatingBuilder setRating(double r)

Set the rating value.

Parameters:

r - The rating value.

Returns:

The builder (for chaining).

clearRating

@EntityAttributeClearer(value="rating")
public RatingBuilder clearRating()

Clear the rating value.

Returns:

The builder (for chaining).

getTimestamp

public long getTimestamp()

Get the timestamp.

Returns:

The timestamp.

setTimestamp

@EntityAttributeSetter(value="timestamp")
public RatingBuilder setTimestamp(long ts)

Set the timestamp.

Parameters:

ts - The timestamp.

Returns:

The builder (for chaining).

clearTimestamp

@EntityAttributeClearer(value="timestamp")
public RatingBuilder clearTimestamp()

build

public Rating build()

Description copied from class: EntityBuilder

Build the entity.

Specified by:

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

Overrides:

build in class AbstractBeanEntityBuilder

Returns:

The entity to build.