org.grouplens.lenskit.inject

Class RecommenderInstantiator

java.lang.Object

org.grouplens.lenskit.inject.RecommenderInstantiator

public final class RecommenderInstantiator
extends Object

Process a recommender graph to deal with its shareable nodes.

Since:

1.2

Compatibility

Experimental

Method Summary

Modifier and Type	Method and Description
static RecommenderInstantiator	create(DAGNode<Component,Dependency> g)
static RecommenderInstantiator	create(DAGNode<Component,Dependency> g, NodeInstantiator instantiator)
static RecommenderInstantiator	forConfig(LenskitConfiguration config) Deprecated.
DAGNode<Component,Dependency>	getGraph() Get the graph from this instantiator.
DAGNode<Component,Dependency>	instantiate() Instantiate the recommender graph.
DAGNode<Component,Dependency>	simulate() Simulate instantiating a graph.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RecommenderInstantiator create(DAGNode<Component,Dependency> g)

create

public static RecommenderInstantiator create(DAGNode<Component,Dependency> g,
                                             NodeInstantiator instantiator)

forConfig

@Deprecated
public static RecommenderInstantiator forConfig(LenskitConfiguration config)
                                                     throws RecommenderConfigurationException

Deprecated.

Throws:

RecommenderConfigurationException

getGraph

public DAGNode<Component,Dependency> getGraph()

Get the graph from this instantiator.

Returns:

The graph. This method returns a defensive copy, so modifying it will not modify the graph underlying this instantiator.

instantiate

public DAGNode<Component,Dependency> instantiate()
                                          throws RecommenderBuildException

Instantiate the recommender graph. This requires the graph to have been resolved with a real DAO instance, not just a class, if anything references the DAO. Use LenskitConfiguration.buildGraph() to get such a graph.

Returns:

A new recommender graph with all shareable nodes pre-instantiated.

Throws:

RecommenderBuildException - If there is an error instantiating the graph.

simulate

public DAGNode<Component,Dependency> simulate()
                                       throws RecommenderBuildException

Simulate instantiating a graph.

Returns:

The simulated graph.

Throws:

RecommenderBuildException