org.lenskit.config

Class LenskitConfigDSL

java.lang.Object

org.grouplens.grapht.AbstractContext

org.lenskit.inject.AbstractConfigContext

org.lenskit.config.BindingDSL

org.lenskit.config.LenskitConfigDSL

All Implemented Interfaces:

Context, LenskitConfigContext

Direct Known Subclasses:

MultiAlgorithmDSL

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, java.net.URI base) Construct a new delegate.
	LenskitConfigDSL(ConfigurationLoader loader, java.net.URI base) Construct a new delegate with an empty configuration.

Method Summary

Modifier and Type	Method and Description
java.net.URI	getBaseURI() Get the base URL for this configuration.
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(java.net.URI uri) Include another configuration file.
void	root(java.lang.Class<?> type) Add a root type.
void	setBaseURI(java.net.URI base) Set the base URI for this configuration.

Methods inherited from class org.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.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.

Parameters:

loader - The configuration loader.

LenskitConfigDSL

public LenskitConfigDSL(ConfigurationLoader loader,
                        java.net.URI base)

Construct a new delegate with an empty configuration.

Parameters:

loader - The configuration loader

base - The base URL

LenskitConfigDSL

protected LenskitConfigDSL(ConfigurationLoader loader,
                           LenskitConfiguration cfg,
                           java.net.URI base)

Construct a new delegate.

Parameters:

loader - The configuration loader.

cfg - The context to configure.

base - The base URL.

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:

java.lang.IllegalStateException - if there is no associated loader.

getBaseURI

@Nonnull
public java.net.URI getBaseURI()

Get the base URL for this configuration.

Returns:

The base URI.

setBaseURI

public void setBaseURI(java.net.URI base)

Set the base URI for this configuration.

Parameters:

base - The base URI.

root

public void root(java.lang.Class<?> type)

Add a root type.

Parameters:

type - The type to add.

See Also:

LenskitConfiguration.addRoot(Class)

include

public void include(java.net.URI uri)
             throws java.io.IOException,
                    RecommenderConfigurationException

Description copied from class: BindingDSL

Include another configuration file.

Overrides:

include in class BindingDSL

Parameters:

uri - The URI of the configuration file.

Throws:

java.io.IOException - if an error is thrown loading the script.

RecommenderConfigurationException - if there is an error running the script.