org.lenskit.config

Class ConfigHelpers

java.lang.Object

org.lenskit.config.ConfigHelpers

public class ConfigHelpers
extends java.lang.Object

LensKit configuration helper utilities.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
static void	configure(LenskitConfiguration config, groovy.lang.Closure<?> block) Modify a configuration from a closure.
static LenskitConfiguration	load(groovy.lang.Closure<?> block) Load a LensKit configuration from a Groovy closure.
static LenskitConfiguration	load(java.io.File script) Load a LensKit configuration from a script file.
static LenskitConfiguration	load(java.lang.String script) Deprecated. Loading from Groovy source strings is confusing.
static LenskitConfiguration	load(java.net.URL script) Load a LensKit configuration from a script URL.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static LenskitConfiguration load(@DelegatesTo(value=LenskitConfigDSL.class)
                                        groovy.lang.Closure<?> block)
                                 throws RecommenderConfigurationException

Load a LensKit configuration from a Groovy closure. This is useful for using the Groovy DSL in unit tests.

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 LensKit configuration.

Throws:

RecommenderConfigurationException

See Also:

ConfigurationLoader.load(groovy.lang.Closure)

load

@Deprecated
public static LenskitConfiguration load(java.lang.String script)
                                             throws RecommenderConfigurationException

Deprecated. Loading from Groovy source strings is confusing.

Load a LensKit configuration from a script (as a string).

Parameters:

script - The script source text to evaluate.

Returns:

The LensKit configuration.

Throws:

RecommenderConfigurationException

load

public static LenskitConfiguration load(java.io.File script)
                                 throws java.io.IOException,
                                        RecommenderConfigurationException

Load a LensKit configuration from a script file.

Parameters:

script - The script source file to evaluate.

Returns:

The LensKit configuration.

Throws:

java.io.IOException

RecommenderConfigurationException

load

public static LenskitConfiguration load(java.net.URL script)
                                 throws java.io.IOException,
                                        RecommenderConfigurationException

Load a LensKit configuration from a script URL.

Parameters:

script - The script source URL to evaluate.

Returns:

The LensKit configuration.

Throws:

java.io.IOException

RecommenderConfigurationException

configure

public static void configure(LenskitConfiguration config,
                             @Nonnull @DelegatesTo(value=LenskitConfigDSL.class)
                             groovy.lang.Closure<?> block)
                      throws RecommenderConfigurationException

Modify 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.

Throws:

RecommenderConfigurationException