org.grouplens.lenskit.config

Class LenskitConfigDSL

java.lang.Object

org.grouplens.grapht.AbstractContext

org.grouplens.lenskit.inject.AbstractConfigContext

org.grouplens.lenskit.config.BindingDSL

org.grouplens.lenskit.config.LenskitConfigDSL

All Implemented Interfaces:

Context, LenskitConfigContext

Direct Known Subclasses:

AlgorithmInstanceBuilderDelegate

public class LenskitConfigDSL
extends BindingDSL

Methods for the LensKit configuration DSL. This extends BindingDSL with additional methods available at the top level for configuring the LensKit configuration itself.

Since:

1.2

Constructor Summary

Constructors

Modifier	Constructor and Description
	LenskitConfigDSL(ConfigurationLoader loader) Construct a new delegate with an empty configuration.
protected	LenskitConfigDSL(ConfigurationLoader loader, LenskitConfiguration cfg) Construct a new delegate.

Method Summary

Modifier and Type	Method and Description
LenskitConfiguration	getConfig() Get the LensKit configuration being configured.
ConfigurationLoader	getConfigLoader() Get the configuration loader associated with this DSL (used to power the include(java.io.File) method).
void	include(File file) Include another configuration file.
void	root(Class<?> type) Add a root type.

Methods inherited from class org.grouplens.lenskit.config.BindingDSL

addComponent, at, at, at, at, at, at, bind, bind, bindAny, domain, getContext, include, include, include, matching, matching, prefDomain, set, within, within, within, within, within, within

Methods inherited from class org.grouplens.lenskit.inject.AbstractConfigContext

addComponent, in, in, in, wrapContext

Methods inherited from class java.lang.Object

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

Constructor Detail

LenskitConfigDSL

public LenskitConfigDSL(ConfigurationLoader loader)

Construct a new delegate with an empty configuration.

LenskitConfigDSL

protected LenskitConfigDSL(ConfigurationLoader loader,
                           LenskitConfiguration cfg)

Construct a new delegate.

Parameters:

cfg - The context to configure.

Method Detail

getConfig

public LenskitConfiguration getConfig()

Get the LensKit configuration being configured.

Returns:

The configuration that this delegate configures.

getConfigLoader

public ConfigurationLoader getConfigLoader()

Get the configuration loader associated with this DSL (used to power the include(java.io.File) method).

Throws:

IllegalStateException - if there is no associated loader.

root

public void root(Class<?> type)

Add a root type.

Parameters:

type - The type to add.

See Also:

LenskitConfiguration.addRoot(Class)

include

public void include(File file)
             throws IOException,
                    RecommenderConfigurationException

Description copied from class: BindingDSL

Include another configuration file.

Overrides:

include in class BindingDSL

Parameters:

file - The configuration file.

Throws:

IOException - if an error is thrown loading the script.

RecommenderConfigurationException - if there is an error running the script.