org.lenskit

Class LenskitConfiguration

java.lang.Object

org.grouplens.grapht.AbstractContext

org.lenskit.inject.AbstractConfigContext

org.lenskit.LenskitConfiguration

All Implemented Interfaces:

Context, LenskitConfigContext

public class LenskitConfiguration
extends AbstractConfigContext

A LensKit algorithm configuration. Once you have a configuration, you can pass it to LenskitRecommenderEngine.build(LenskitConfiguration) to build a recommender engine, or LenskitRecommender.build(LenskitConfiguration) to skip the engine and just build a recommender.

Since:

1.2

Compatibility

Public

Constructor Summary

Constructors

Constructor and Description
LenskitConfiguration() Create a new LensKit configuration.
LenskitConfiguration(LenskitConfiguration other) Create a new copy of a LensKit configuration.

Method Summary

Modifier and Type	Method and Description
void	addRoot(java.lang.Class<?> componentType) Add the specified component type as a root component.
LenskitConfigContext	at(java.lang.annotation.Annotation qualifier, java.lang.Class<?> type)
LenskitConfigContext	at(java.lang.Class<?> type)
LenskitConfigContext	at(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier, java.lang.Class<?> type)
<T> LenskitBinding<T>	bind(java.lang.Class<T> type)
DAGNode<Component,Dependency>	buildGraph() Deprecated. This shouldn’t be used anymore.
void	clearRoots() Clear the set of roots, removing all configured and default roots.
LenskitConfiguration	copy() Convenience method to copy a LensKit configuration.
BindingFunctionBuilder	getBindings()
java.util.Set<java.lang.Class<?>>	getRoots()
LenskitConfigContext	matching(ContextPattern pattern)
LenskitConfigContext	within(java.lang.annotation.Annotation qualifier, java.lang.Class<?> type)
LenskitConfigContext	within(java.lang.Class<?> type)
LenskitConfigContext	within(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier, java.lang.Class<?> type)

Methods inherited from class org.lenskit.inject.AbstractConfigContext

addComponent, addComponent, bind, bindAny, in, in, in, set, wrapContext

Methods inherited from class java.lang.Object

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

Constructor Detail

LenskitConfiguration

public LenskitConfiguration()

Create a new LensKit configuration.

LenskitConfiguration

public LenskitConfiguration(LenskitConfiguration other)

Create a new copy of a LensKit configuration.

Parameters:

other - The configuration to copy.

Method Detail

copy

public LenskitConfiguration copy()

Convenience method to copy a LensKit configuration.

Returns:

An independent copy of this configuration.

addRoot

public void addRoot(java.lang.Class<?> componentType)

Add the specified component type as a root component. This forces it (and its dependencies) to be resolved, and makes it available from the resulting recommenders.

Parameters:

componentType - The type of component to add as a root (typically an interface).

See Also:

LenskitRecommender.get(Class)

clearRoots

public void clearRoots()

Clear the set of roots, removing all configured and default roots. This is almost never desired in production, but is useful for testing.

bind

public <T> LenskitBinding<T> bind(java.lang.Class<T> type)

within

public LenskitConfigContext within(java.lang.Class<?> type)

within

public LenskitConfigContext within(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier,
                                   java.lang.Class<?> type)

within

public LenskitConfigContext within(java.lang.annotation.Annotation qualifier,
                                   java.lang.Class<?> type)

matching

public LenskitConfigContext matching(ContextPattern pattern)

at

public LenskitConfigContext at(java.lang.Class<?> type)

at

public LenskitConfigContext at(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier,
                               java.lang.Class<?> type)

at

public LenskitConfigContext at(java.lang.annotation.Annotation qualifier,
                               java.lang.Class<?> type)

getBindings

public BindingFunctionBuilder getBindings()

getRoots

public java.util.Set<java.lang.Class<?>> getRoots()

buildGraph

@Deprecated
public DAGNode<Component,Dependency> buildGraph()
                                                     throws RecommenderConfigurationException

Deprecated. This shouldn’t be used anymore.

Get a mockup of the full recommender graph. This fully resolves the graph so that it can be analyzed, but does not create any objects.

Returns:

The full graph.

Throws:

RecommenderConfigurationException