org.grouplens.lenskit.eval

Class EvalConfig

java.lang.Object

org.grouplens.lenskit.eval.EvalConfig

public class EvalConfig
extends Object

The class that represents the set of properties passed in to a Groovy evaluation script. These properties will have been created by a caller, who passes in a Properties object, which will be embedded in the instance of this class. This instance will then be passed in to the Groovy evaluation script under a special name, so the script can use it to pull properties out.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANALYSIS_DIR_PROPERTY
static String	DATA_DIR_PROPERTY
static String	EVAL_SCRIPT_PROPERTY
static String	EVAL_SCRIPTFILES_PROPERTY
static String	FORCE_PROPERTY
static String	SCRIPT_DIR_PROPERTY
static String	SKIP_PROPERTY
static String	THREAD_COUNT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
EvalConfig(Map props) Construct a new eval config using the specified properties.

Method Summary

Modifier and Type	Method and Description
boolean	force() Query whether the script should run in “force” mode.
String	get(String key) Get the value of a property.
String	get(String key, String defaultValue) Get the value of a property.
String	getAnalysisDir() Get the analysis directory for this evaluation.
String	getDataDir() Get the data directory for this evaluation.
String	getScript() Get the script for this evaluation.
String	getScriptDir() Get the data directory for this evaluation.
int	getThreadCount()

Methods inherited from class java.lang.Object

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

Field Detail

FORCE_PROPERTY

public static final String FORCE_PROPERTY

See Also:

Constant Field Values

SKIP_PROPERTY

public static final String SKIP_PROPERTY

See Also:

Constant Field Values

EVAL_SCRIPT_PROPERTY

public static final String EVAL_SCRIPT_PROPERTY

See Also:

Constant Field Values

EVAL_SCRIPTFILES_PROPERTY

public static final String EVAL_SCRIPTFILES_PROPERTY

See Also:

Constant Field Values

SCRIPT_DIR_PROPERTY

public static final String SCRIPT_DIR_PROPERTY

See Also:

Constant Field Values

DATA_DIR_PROPERTY

public static final String DATA_DIR_PROPERTY

See Also:

Constant Field Values

ANALYSIS_DIR_PROPERTY

public static final String ANALYSIS_DIR_PROPERTY

See Also:

Constant Field Values

THREAD_COUNT_PROPERTY

public static final String THREAD_COUNT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

EvalConfig

public EvalConfig(@Nonnull
                  Map props)

Construct a new eval config using the specified properties.

Parameters:

props - The properties to use.

Method Detail

get

public String get(String key,
                  @Nullable
                  String defaultValue)

Get the value of a property.

Parameters:

key - The name of the property

defaultValue - The value to return if no such key

Returns:

The value of the property

get

public String get(String key)

Get the value of a property.

Parameters:

key - The name of the property

Returns:

The value of the property, or null if there is no such key

force

public boolean force()

Query whether the script should run in “force” mode.

Returns:

true if the script should run in force mode.

getScript

public String getScript()

Get the script for this evaluation. Will often include a path.

Returns:

The script name, or "eval.groovy" if none has been set.

getDataDir

public String getDataDir()

Get the data directory for this evaluation.

Returns:

The data directory, or "." if none has been set.

getScriptDir

public String getScriptDir()

Get the data directory for this evaluation.

Returns:

The data directory, or "." if none has been set.

getAnalysisDir

public String getAnalysisDir()

Get the analysis directory for this evaluation.

Returns:

The analysis directory, or "." if none has been set.

getThreadCount

public int getThreadCount()