org.lenskit.data.events

Interface EventBuilder<E extends Event>

All Known Implementing Classes:

RatingBuilder

public interface EventBuilder<E extends Event>

Interface for common behavior for event builders.

Since:

2.2

See Also:

RatingBuilder

Method Summary

Modifier and Type	Method and Description
E	build() Builds the event.
EventBuilder	clone() Clone this event builder.
EventBuilder<E>	reset() Clear the rating builder, as if it were freshly instantiated..
EventBuilder<E>	setItemId(long iid) Set the item ID for this event.
EventBuilder<E>	setTimestamp(long ts) Set the timestamp for this event.
EventBuilder<E>	setUserId(long uid) Set the user ID for this event.

Method Detail

reset

EventBuilder<E> reset()

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

setUserId

EventBuilder<E> setUserId(long uid)

Set the user ID for this event.

Parameters:

uid - The user ID.

Returns:

The event builder (for chaining).

setItemId

EventBuilder<E> setItemId(long iid)

Set the item ID for this event.

Parameters:

iid - The item ID.

Returns:

The event builder (for chaining).

setTimestamp

EventBuilder<E> setTimestamp(long ts)

Set the timestamp for this event.

Parameters:

ts - The event timestamp.

Returns:

The event builder (for chaining).

build

E build()

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.

Returns:

A new event.

Throws:

IllegalStateException - if the builder is not ready to build an object (e.g. some needed setter has not been called).

clone

EventBuilder clone()

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

Returns:

A copy of this event builder.