org.lenskit.config

Class ConfigurationLoader

java.lang.Object

org.lenskit.config.ConfigurationLoader

public class ConfigurationLoader
extends Object

Load LensKit configurations using the configuration DSL.

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
ConfigurationLoader() Construct a new configuration loader.
ConfigurationLoader(ClassLoader loader) Construct a new configuration loader.

Method Summary

Modifier and Type	Method and Description
ClassDirectory	getDirectory()
LenskitConfiguration	load(groovy.lang.Closure<?> block) Deprecated. Use ConfigHelpers.load(groovy.lang.Closure) instead.
LenskitConfiguration	load(File file) Load a configuration from a file.
LenskitConfiguration	load(String source) Deprecated. Loading from Groovy sources as strings is confusing.
LenskitConfiguration	load(URL url) Load a configuration from a URL.
LenskitConfigScript	loadScript(File file) Load a configuration script from a file.
LenskitConfigScript	loadScript(groovy.lang.GroovyCodeSource source, URI base) Load a LensKit configuration script.
LenskitConfigScript	loadScript(String source) Load a configuration script from a script source.
LenskitConfigScript	loadScript(URL url) Load a configuration script from a URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationLoader

public ConfigurationLoader()

Construct a new configuration loader. It uses the current thread’s class loader.

ConfigurationLoader

public ConfigurationLoader(ClassLoader loader)

Construct a new configuration loader.

Parameters:

loader - The class loader to use.

Method Detail

getDirectory

public ClassDirectory getDirectory()

loadScript

public LenskitConfigScript loadScript(groovy.lang.GroovyCodeSource source,
                                      URI base)
                               throws RecommenderConfigurationException

Load a LensKit configuration script. This method is for internal use that needs to override how configuration scripts are loaded.

Parameters:

source - The source

base - The base URI for this configuration

Returns:

the configuration script.

Throws:

RecommenderConfigurationException

load

public LenskitConfiguration load(@Nonnull
                                 File file)
                          throws IOException,
                                 RecommenderConfigurationException

Load a configuration from a file.

Parameters:

file - The configuration script to load.

Returns:

The resulting LensKit configuration.

Throws:

IOException

RecommenderConfigurationException

load

public LenskitConfiguration load(@Nonnull
                                 URL url)
                          throws IOException,
                                 RecommenderConfigurationException

Load a configuration from a URL.

Parameters:

url - The configuration script to load.

Returns:

The resulting LensKit configuration.

Throws:

IOException

RecommenderConfigurationException

load

@Deprecated
public LenskitConfiguration load(@Nonnull
                                              String source)
                                       throws RecommenderConfigurationException

Deprecated. Loading from Groovy sources as strings is confusing.

Load a configuration from a script source.

Parameters:

source - The configuration script to load.

Returns:

The resulting LensKit configuration.

Throws:

RecommenderConfigurationException

loadScript

public LenskitConfigScript loadScript(@Nonnull
                                      File file)
                               throws IOException,
                                      RecommenderConfigurationException

Load a configuration script from a file.

Parameters:

file - The configuration script to load.

Returns:

The resulting LensKit configuration.

Throws:

IOException

RecommenderConfigurationException

loadScript

public LenskitConfigScript loadScript(@Nonnull
                                      URL url)
                               throws IOException,
                                      RecommenderConfigurationException

Load a configuration script from a URL.

Parameters:

url - The configuration script to load.

Returns:

The resulting LensKit configuration.

Throws:

IOException

RecommenderConfigurationException

loadScript

public LenskitConfigScript loadScript(@Nonnull
                                      String source)
                               throws RecommenderConfigurationException

Load a configuration script from a script source.

Parameters:

source - The configuration script to load.

Returns:

The resulting LensKit configuration.

Throws:

RecommenderConfigurationException

load

@Deprecated
public LenskitConfiguration load(@Nonnull
                                              groovy.lang.Closure<?> block)
                                       throws RecommenderConfigurationException

Deprecated. Use ConfigHelpers.load(groovy.lang.Closure) instead.

Load a configuration from a closure. The class loader is not really consulted in this case.

Parameters:

block - The block to evaluate. This block will be evaluated with a delegate providing the LensKit DSL and the Closure.DELEGATE_FIRST resolution strategy.

Returns:

The resulting LensKit configuration.

Throws:

RecommenderConfigurationException