org.grouplens.lenskit.config

Class BindingDSL

java.lang.Object

org.grouplens.grapht.AbstractContext

org.grouplens.lenskit.inject.AbstractConfigContext

org.grouplens.lenskit.config.BindingDSL

All Implemented Interfaces:

Context, LenskitConfigContext

Direct Known Subclasses:

LenskitConfigDSL

public class BindingDSL
extends AbstractConfigContext

Groovy DSL definition for configuring LensKit recommenders. This class is the base class of configuration scripts and the delegate against which configuration blocks are run.

The fact that this extends AbstractConfigContext is basically an implementation detail, to make sure that we always provide proxies for all the methods.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
void	addComponent(Object obj) Add a component object to the injector.
LenskitConfigContext	at(Annotation qualifier, Class<?> type)
LenskitConfigContext	at(Annotation qualifier, Class<?> type, groovy.lang.Closure<?> block) Enclose a block of configuration in a context.
LenskitConfigContext	at(Class<?> type)
LenskitConfigContext	at(Class<?> type, groovy.lang.Closure<?> block) Configure inside an anchored context using a block.
LenskitConfigContext	at(Class<? extends Annotation> qualifier, Class<?> type)
LenskitConfigContext	at(Class<? extends Annotation> qualifier, Class<?> type, groovy.lang.Closure<?> block) Enclose a block of configuration in a context.
<T> LenskitBinding<T>	bind(Class<? extends Annotation> qual, Class<T> type)
<T> LenskitBinding<T>	bind(Class<T> type)
<T> LenskitBinding<T>	bindAny(Class<T> type)
PreferenceDomain	domain(Map<String,Object> args) Make and bind a preference domain.
LenskitConfigContext	getContext() Get the LensKit context.
void	include(groovy.lang.Closure<?> cl) Use a closure as additional configuration
void	include(File file) Include another configuration file.
void	include(Module mod) Include a module in this configuration.
void	include(String file) Include another configuration file.
LenskitConfigContext	matching(ContextPattern pattern)
Context	matching(ContextPattern pattern, groovy.lang.Closure<?> block)
PreferenceDomain	prefDomain(Map<String,Object> args) Make a preference domain.
Binding	set(Class<? extends Annotation> param) Start a binding that sets a parameter.
LenskitConfigContext	within(Annotation qualifier, Class<?> type)
LenskitConfigContext	within(Annotation qualifier, Class<?> type, groovy.lang.Closure<?> block) Enclose a block of configuration in a context.
LenskitConfigContext	within(Class<?> type)
LenskitConfigContext	within(Class<?> type, groovy.lang.Closure<?> block) Enclose a block of configuration in a context.
LenskitConfigContext	within(Class<? extends Annotation> qualifier, Class<?> type)
LenskitConfigContext	within(Class<? extends Annotation> qualifier, Class<?> type, groovy.lang.Closure<?> block) Enclose a block of configuration in a context.

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

Method Detail

getContext

public LenskitConfigContext getContext()

Get the LensKit context.

Returns:

The LensKit context.

include

public void include(groovy.lang.Closure<?> cl)

Use a closure as additional configuration

Parameters:

cl - A closure that is run on this context to do additional configuration.

include

public void include(File file)
             throws IOException,
                    RecommenderConfigurationException

Include another configuration file.

Parameters:

file - The configuration file.

Throws:

IOException - if an error is thrown loading the script.

RecommenderConfigurationException - if there is an error running the script.

UnsupportedOperationException - if the current context does not support loading.

include

public void include(String file)
             throws IOException,
                    RecommenderConfigurationException

Include another configuration file.

Parameters:

file - The configuration file.

Throws:

IOException

RecommenderConfigurationException

See Also:

include(File)

include

public void include(Module mod)

Include a module in this configuration.

Parameters:

mod - The module to include.

bind

public <T> LenskitBinding<T> bind(Class<T> type)

See Also:

LenskitConfigContext.bind(Class)

bind

public <T> LenskitBinding<T> bind(Class<? extends Annotation> qual,
                                  Class<T> type)

Specified by:

bind in interface Context

Specified by:

bind in interface LenskitConfigContext

Overrides:

bind in class AbstractConfigContext

See Also:

LenskitConfigContext.bind(Class, Class)

bindAny

public <T> LenskitBinding<T> bindAny(Class<T> type)

Specified by:

bindAny in interface Context

Specified by:

bindAny in interface LenskitConfigContext

Overrides:

bindAny in class AbstractConfigContext

See Also:

LenskitConfigContext.bindAny(Class)

set

public Binding set(@Nonnull
                   Class<? extends Annotation> param)

Description copied from interface: LenskitConfigContext

Start a binding that sets a parameter. Parameters are qualifiers that bear the Parameter annotation.

Specified by:

set in interface LenskitConfigContext

Overrides:

set in class AbstractConfigContext

Parameters:

param - The parameter to set.

Returns:

The binding for this parameter. It is untyped, as many types will be accepted and attempted.

See Also:

LenskitConfigContext.set(Class)

addComponent

public void addComponent(@Nonnull
                         Object obj)

Description copied from interface: LenskitConfigContext

Add a component object to the injector. This is the equivalent of:

 this.bind(obj.getClass()).to(obj);
 

It has the result of making obj available satisfy dependencies on its class or, via supertype binding generation, any of its supertypes. Explicit bindings for those supertypes will override this binding.

Specified by:

addComponent in interface LenskitConfigContext

Overrides:

addComponent in class AbstractConfigContext

Parameters:

obj - The object to register.

within

public LenskitConfigContext within(Class<?> type)

See Also:

LenskitConfigContext.within(Class)

within

public LenskitConfigContext within(Class<?> type,
                                   groovy.lang.Closure<?> block)

Enclose a block of configuration in a context. The block is invoked with a delegate that adds bindings within the specified context.

Parameters:

type - The type to match for the context.

block - The configuration block.

Returns:

The configuration context.

See Also:

LenskitConfigContext.within(Class)

within

public LenskitConfigContext within(@Nullable
                                   Class<? extends Annotation> qualifier,
                                   Class<?> type)

See Also:

LenskitConfigContext.within(Class, Class)

within

public LenskitConfigContext within(@Nullable
                                   Class<? extends Annotation> qualifier,
                                   Class<?> type,
                                   groovy.lang.Closure<?> block)

Enclose a block of configuration in a context.

Parameters:

qualifier - The qualifier.

type - The type to match for the context.

block - The configuration block.

Returns:

The configuration context.

See Also:

LenskitConfigContext.within(Class, Class), within(Class, Closure)

within

public LenskitConfigContext within(@Nullable
                                   Annotation qualifier,
                                   Class<?> type)

See Also:

LenskitConfigContext.within(Annotation, Class)

within

public LenskitConfigContext within(@Nullable
                                   Annotation qualifier,
                                   Class<?> type,
                                   groovy.lang.Closure<?> block)

Enclose a block of configuration in a context.

Parameters:

qualifier - The qualifier.

type - The type to match for the context.

block - The configuration block.

Returns:

The configuration context.

See Also:

LenskitConfigContext.within(Annotation, Class), within(Class, Closure)

matching

public LenskitConfigContext matching(ContextPattern pattern)

matching

public Context matching(ContextPattern pattern,
                        groovy.lang.Closure<?> block)

at

public LenskitConfigContext at(Class<?> type)

See Also:

LenskitConfigContext.at(Class)

at

public LenskitConfigContext at(Class<?> type,
                               groovy.lang.Closure<?> block)

Configure inside an anchored context using a block.

Parameters:

type - The type.

block - The configuration block.

Returns:

The context.

See Also:

within(Class, Closure)

at

public LenskitConfigContext at(@Nullable
                               Class<? extends Annotation> qualifier,
                               Class<?> type)

See Also:

LenskitConfigContext.at(Class, Class)

at

public LenskitConfigContext at(@Nullable
                               Class<? extends Annotation> qualifier,
                               Class<?> type,
                               groovy.lang.Closure<?> block)

Enclose a block of configuration in a context.

Parameters:

qualifier - The qualifier.

type - The type to match for the context.

block - The configuration block.

Returns:

The configuration context.

See Also:

LenskitConfigContext.at(Class, Class), at(Class, Closure)

at

public LenskitConfigContext at(@Nullable
                               Annotation qualifier,
                               Class<?> type)

See Also:

LenskitConfigContext.at(Annotation, Class)

at

public LenskitConfigContext at(@Nullable
                               Annotation qualifier,
                               Class<?> type,
                               groovy.lang.Closure<?> block)

Enclose a block of configuration in a context.

Parameters:

qualifier - The qualifier.

type - The type to match for the context.

block - The configuration block.

Returns:

The configuration context.

See Also:

LenskitConfigContext.at(Annotation, Class), at(Class, Closure)

domain

public PreferenceDomain domain(Map<String,Object> args)

Make and bind a preference domain. With this method, this:

     domain minimum: 1, maximum: 5
 

is equivalent to:

     bind PreferenceDomain to prefDomain(minimum: 1, maximum: 5)
 

Parameters:

args - The arguments.

Returns:

The preference domain.

See Also:

prefDomain(java.util.Map)

prefDomain

public PreferenceDomain prefDomain(Map<String,Object> args)

Make a preference domain. This method takes three named arguments:

minimum

The minimum rating

maximum

The maximum rating

precision (optional)

The preference precision.

Parameters:

args - The arguments.

Returns:

The preference domain.

See Also:

PreferenceDomain