org.lenskit.eval.traintest

Class AlgorithmInstanceBuilder

java.lang.Object

org.lenskit.eval.traintest.AlgorithmInstanceBuilder

All Implemented Interfaces:

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

public class AlgorithmInstanceBuilder
extends java.lang.Object
implements org.apache.commons.lang3.builder.Builder<AlgorithmInstance>

Builder for algorithm instances.

Constructor Summary

Constructors

Constructor and Description
AlgorithmInstanceBuilder() Construct a new algorithm instance builder.
AlgorithmInstanceBuilder(java.lang.String name) Construct a new algorithm instance builder with a name.

Method Summary

Modifier and Type	Method and Description
AlgorithmInstance	build()
AlgorithmInstanceBuilder	extend() Create a new builder that inherits from this builder.
java.util.Map<java.lang.String,java.lang.Object>	getAllAttributes() Get all attributes of this algorithm instance.
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Get the attributes of this algorithm instance.
LenskitConfiguration	getConfig() Get the LensKit configuration.
java.util.List<LenskitConfiguration>	getConfigurations() Get the list of configurations that comprise this instance.
java.lang.String	getName() Get the algorithm name.
AlgorithmInstanceBuilder	setAttribute(java.lang.String attr, java.lang.Object value) Set an attribute for this algorithm instance.
AlgorithmInstanceBuilder	setConfig(LenskitConfiguration cfg) Set the LensKit configuration to use.
AlgorithmInstanceBuilder	setName(java.lang.String n) Set the algorithm name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmInstanceBuilder

public AlgorithmInstanceBuilder()

Construct a new algorithm instance builder.

AlgorithmInstanceBuilder

public AlgorithmInstanceBuilder(java.lang.String name)

Construct a new algorithm instance builder with a name.

Parameters:

name - The algorithm name.

Method Detail

setName

public AlgorithmInstanceBuilder setName(java.lang.String n)

Set the algorithm name.

Parameters:

n - The name for this algorithm instance.

Returns:

The command for chaining.

getName

public java.lang.String getName()

Get the algorithm name.

Returns:

The algorithm name.

setAttribute

public AlgorithmInstanceBuilder setAttribute(@Nonnull
                                             java.lang.String attr,
                                             @Nonnull
                                             java.lang.Object value)

Set an attribute for this algorithm instance. Used for distinguishing similar instances in an algorithm family.

Parameters:

attr - The attribute name.

value - The attribute value.

Returns:

The command for chaining.

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Get the attributes of this algorithm instance.

Returns:

A map of user-defined attributes for this algorithm instance, excluding attributes inherited from the parent.

getAllAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAllAttributes()

Get all attributes of this algorithm instance.

Returns:

A map of all attributes in this algorithm instance.

getConfig

public LenskitConfiguration getConfig()

Get the LensKit configuration.

Returns:

The LensKit configuration.

setConfig

public AlgorithmInstanceBuilder setConfig(LenskitConfiguration cfg)

Set the LensKit configuration to use.

Parameters:

cfg - The configuration to use. This will override any non-inherited configuration.

Returns:

The builder (for chaining).

getConfigurations

public java.util.List<LenskitConfiguration> getConfigurations()

Get the list of configurations that comprise this instance.

Returns:

The list of configurations comprising this instance.

extend

public AlgorithmInstanceBuilder extend()

Create a new builder that inherits from this builder. Changes to the returned builder will not affect this builder, but subsequent changes to this builder will affect the inherited builder.

Returns:

The duplicate instance builder.

build

public AlgorithmInstance build()

Specified by:

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