org.lenskit

Class LenskitRecommenderEngineBuilder

java.lang.Object

org.lenskit.LenskitRecommenderEngineBuilder

public class LenskitRecommenderEngineBuilder
extends java.lang.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.

While this class is subclassable, and exposes protected methods, users should not subclass it. Subclassing is supported only to enable the evaluator.

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() Deprecated. Use build(DataAccessObject)
LenskitRecommenderEngine	build(DataAccessObject dao) Build the recommender engine.
LenskitRecommender	buildRecommender(DataAccessObject dao) Build the recommender directly, skipping an engine.
protected DAGNode<Component,Dependency>	buildRecommenderGraph(DataAccessObject dao) Build a recommender graph for this engine builder’s configuration.
java.lang.ClassLoader	getClassLoader() Get the class loader this builder will use.
protected DAGNode<Component,Dependency>	instantiateGraph(DAGNode<Component,Dependency> graph) Instantiate the recommender graph.
LenskitRecommenderEngineBuilder	setClassLoader(java.lang.ClassLoader loader) 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 java.lang.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(java.lang.ClassLoader loader)

Set the class loader to use.

Parameters:

loader - 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

@Deprecated
public LenskitRecommenderEngine build()
                                           throws RecommenderBuildException

Deprecated. Use build(DataAccessObject)

Build the recommender engine.

Returns:

The built recommender engine, with excluded components removed.

Throws:

RecommenderBuildException - if there is an error building the recommender.

build

public LenskitRecommenderEngine build(DataAccessObject dao)
                               throws RecommenderBuildException

Build the recommender engine.

Parameters:

dao - The data access object to use. Can be null to build without a DAO, but this is only useful in special cases.

Returns:

The built recommender engine, with excluded components removed.

Throws:

RecommenderBuildException - if there is an error building the engine.

buildRecommender

public LenskitRecommender buildRecommender(DataAccessObject dao)
                                    throws RecommenderBuildException

Build the recommender directly, skipping an engine. This does not separate the recommender from the DAO, it just directly builds it.

Parameters:

dao - The data access object to use. Can be null to build without a DAO, but this is only useful in special cases.

Returns:

The built recommender engine, with excluded components removed.

Throws:

RecommenderBuildException - if there is an error building the engine.

buildRecommenderGraph

protected DAGNode<Component,Dependency> buildRecommenderGraph(DataAccessObject dao)

Build a recommender graph for this engine builder’s configuration.

Clients generally do not need to use this; it is exposed for the evaluator.

Parameters:

dao - The DAO, if available.

Returns:

The graph.

instantiateGraph

protected DAGNode<Component,Dependency> instantiateGraph(DAGNode<Component,Dependency> graph)

Instantiate the recommender graph.

Parameters:

graph - The recommender graph.

Returns:

The instantiated graph.