org.grouplens.lenskit.scored

Class ScoredIdBuilder

java.lang.Object

org.grouplens.lenskit.scored.ScoredIdBuilder

All Implemented Interfaces:

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

public class ScoredIdBuilder
extends Object
implements org.apache.commons.lang3.builder.Builder<ScoredId>

Use a ScoredId.Builder to instantiate new ScoredId objects.

Since:

1.1

Author:

GroupLens Research

Constructor Summary

Constructors

Constructor and Description
ScoredIdBuilder() Create a ScoredIdBuilder.
ScoredIdBuilder(long id) Create a ScoredIdBuilder.
ScoredIdBuilder(long id, double score) Create a ScoredIdBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
ScoredIdBuilder	addChannel(Symbol symbol, double value) Add a new unboxed side channel to the ScoredId under construction.
<K> ScoredIdBuilder	addChannel(TypedSymbol<K> symbol, K value) Add a new side channel to the ScoredId under construction.
ScoredId	build() Finish constructing the ScoredId and instantiate it.
ScoredIdBuilder	clearChannels() Removes all channels (typed and double) from new ScoredId objects produced by the builder.
ScoredIdBuilder	setId(long id) Change the ID of the ScoredID object under construction.
ScoredIdBuilder	setScore(double score) Change the score of the ScoredId object under construction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScoredIdBuilder

public ScoredIdBuilder()

Create a ScoredIdBuilder. Any ScoredId objects created by this builder will have the default ID of 0 and default score of 0 unless they are explicitly set by the user.

ScoredIdBuilder

public ScoredIdBuilder(long id)

Create a ScoredIdBuilder. Any ScoredId objects created by this builder will have the specified ID and a default score of 0 unless they are explicitly changed by the user.

Parameters:

id - The numerical ID of ScoredId objects produced by this builder.

ScoredIdBuilder

public ScoredIdBuilder(long id,
               double score)

Create a ScoredIdBuilder. Any ScoredId objects created by this builder will have the specified ID and score unless they are explicitly changed by the user.

Parameters:

id - The numerical ID of ScoredId objects produced by this builder.

score - The score for ScoredId objects produced by this builder.

Method Detail

setId

public ScoredIdBuilder setId(long id)

Change the ID of the ScoredID object under construction.

Parameters:

id - The ID to be used for new ScoredId objects.

Returns:

This builder (for chaining)

setScore

public ScoredIdBuilder setScore(double score)

Change the score of the ScoredId object under construction.

Parameters:

score - The score to be used for new ScoredId objects.

Returns:

This builder (for chaining)

addChannel

public ScoredIdBuilder addChannel(Symbol symbol,
                         double value)

Add a new unboxed side channel to the ScoredId under construction.

Parameters:

symbol - The symbol for the side channel.

value - The numerical value for the side channel.

Returns:

This builder (for chaining)

See Also:

addChannel(TypedSymbol, Object)

addChannel

public <K> ScoredIdBuilder addChannel(@Nonnull
                             TypedSymbol<K> symbol,
                             @Nonnull
                             K value)

Add a new side channel to the ScoredId under construction.

Parameters:

symbol - The symbol for the side channel.

value - The value for the side channel.

Returns:

This builder (for chaining)

clearChannels

public ScoredIdBuilder clearChannels()

Removes all channels (typed and double) from new ScoredId objects produced by the builder.

Returns:

This builder (for chaining)

build

public ScoredId build()

Finish constructing the ScoredId and instantiate it.

Specified by:

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

Returns:

A new ScoredId object.