org.grouplens.lenskit.eval

Class EvalProject

java.lang.Object

org.grouplens.lenskit.eval.EvalProject

public class EvalProject
extends Object

An eval "project", the eval script equivalent of an Ant project. This is used and configured by an EvalScript and provides access to options, targets, etc.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
EvalProject(Properties props) Construct a new eval project.
EvalProject(Properties props, ClassLoader loader) Construct a new eval project.

Method Summary

Modifier and Type	Method and Description
void	executeTarget(String name) Execute a target in the project.
void	executeTargets(List<String> names) Execute a sequence of targets.
void	executeTargets(String... names) Execute a sequence of targets.
org.apache.tools.ant.Project	getAntProject() Get the Ant project from this eval project.
ClassLoader	getClassLoader() Get the class loader that should be used for custom class loading.
EvalConfig	getConfig() Get the (legacy) configuration view of this project.
String	getDefaultTarget()
EventBus	getEventBus() Get this project's event bus.
String	getProperty(String propertyName) Get a property value.
Random	getRandom() Get the project's random number generator.
void	setDefaultTarget(String defaultTarget)
void	setRandom(Random random) Set the project's random number generator.
void	setUserProperty(String name, String value) Set a "user" property.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvalProject

public EvalProject(@Nullable
                   Properties props)

Construct a new eval project.

Parameters:

props - A set of additional properties. These properties will be available in the project, in addition to the system properties. This is not where properties from the command line should be supplied; those should be set with setUserProperty(String, String) so that they have Ant-like behavior.

EvalProject

public EvalProject(@Nullable
                   Properties props,
                   ClassLoader loader)

Construct a new eval project.

Parameters:

props - A set of additional properties. These properties will be available in the project, in addition to the system properties. This is not where properties from the command line should be supplied; those should be set with setUserProperty(String, String) so that they have Ant-like behavior.

loader - A class loader. This class loader will be used by the project for custom class loading, such as reading cached objects from disk. If null, the default classloader will be used.

Method Detail

getClassLoader

public ClassLoader getClassLoader()

Get the class loader that should be used for custom class loading.

Returns:

the class loader

getAntProject

public org.apache.tools.ant.Project getAntProject()

Get the Ant project from this eval project.

Returns:

The Ant project.

getEventBus

public EventBus getEventBus()

Get this project's event bus. The event bus is used for things like monitoring instrumentation.

Returns:

The event bus.

getRandom

public Random getRandom()

Get the project's random number generator.

Returns:

The project's random number generator.

setRandom

public void setRandom(Random random)

Set the project's random number generator.

Parameters:

random - The project's random number generator.

getConfig

public EvalConfig getConfig()

Get the (legacy) configuration view of this project.

Returns:

An accessor for the project's configuration.

getProperty

public String getProperty(String propertyName)

Get a property value.

Parameters:

propertyName - The property name.

Returns:

The property value, or null if no such property exists.

setUserProperty

public void setUserProperty(String name,
                            String value)

Set a "user" property. These properties cannot be overridden by property sets in the script.

Parameters:

name - The property to set.

value - The property value.

executeTarget

public void executeTarget(String name)
                   throws org.apache.tools.ant.BuildException

Execute a target in the project.

Parameters:

name - The target to execute.

Throws:

org.apache.tools.ant.BuildException

executeTargets

public void executeTargets(String... names)

Execute a sequence of targets.

Parameters:

names - The targets to execute.

executeTargets

public void executeTargets(List<String> names)

Execute a sequence of targets.

Parameters:

names - The targets to execute.

getDefaultTarget

public String getDefaultTarget()

setDefaultTarget

public void setDefaultTarget(String defaultTarget)