org.grouplens.lenskit.core

Class LenskitRecommenderEngineBuilder

java.lang.Object

org.grouplens.lenskit.core.LenskitRecommenderEngineBuilder

public class LenskitRecommenderEngineBuilder
extends Object

Builds LensKit recommender engines from configurations.

If multiple configurations are used, later configurations superseded previous configurations. This allows you to add a configuration of defaults, followed by a custom configuration. The final build process takes the union of the roots of all provided configurations as the roots of the configured object graph.

Since:

2.1

See Also:

LenskitConfiguration, LenskitRecommenderEngine

Constructor Summary

Constructors

Constructor and Description
LenskitRecommenderEngineBuilder()

Method Summary

Modifier and Type	Method and Description
LenskitRecommenderEngineBuilder	addConfiguration(LenskitConfiguration config) Add a configuration to be included in the recommender engine.
LenskitRecommenderEngineBuilder	addConfiguration(LenskitConfiguration config, ModelDisposition disp) Add a configuration to be used when building the engine.
LenskitRecommenderEngine	build() Build the recommender engine.
ClassLoader	getClassLoader() Get the class loader this builder will use.
LenskitRecommenderEngineBuilder	setClassLoader(ClassLoader classLoader) Set the class loader to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

LenskitRecommenderEngineBuilder

public LenskitRecommenderEngineBuilder()

Method Detail

getClassLoader

public ClassLoader getClassLoader()

Get the class loader this builder will use. By default, it uses the thread's current context class loader (if set).

Returns:

The class loader to be used.

setClassLoader

public LenskitRecommenderEngineBuilder setClassLoader(ClassLoader classLoader)

Set the class loader to use.

Parameters:

classLoader - The class loader to use when building the recommender.

Returns:

The builder (for chaining).

addConfiguration

public LenskitRecommenderEngineBuilder addConfiguration(LenskitConfiguration config)

Add a configuration to be included in the recommender engine. This is the equivalent of calling addConfiguration(LenskitConfiguration, ModelDisposition) with the ModelDisposition.INCLUDED.

Parameters:

config - The configuration.

Returns:

The builder (for chaining).

addConfiguration

public LenskitRecommenderEngineBuilder addConfiguration(LenskitConfiguration config,
                                                        ModelDisposition disp)

Add a configuration to be used when building the engine.

Parameters:

config - The configuration.

disp - The disposition for this configuration.

Returns:

The builder (for chaining).

build

public LenskitRecommenderEngine build()
                               throws RecommenderBuildException

Build the recommender engine.

Returns:

The built recommender engine, with excluded components removed.

Throws:

RecommenderBuildException