org.grouplens.lenskit.eval.script

Class EvalScript

java.lang.Object

groovy.lang.GroovyObjectSupport

groovy.lang.Script

org.grouplens.lenskit.eval.script.EvalScript

All Implemented Interfaces:

groovy.lang.GroovyObject

public class EvalScript
extends groovy.lang.Script
implements groovy.lang.GroovyObject

Base class for evaluator configuration scripts. It contains the metaclass machinery to set up evaluation taskMap.

Since:

0.10

Field Summary

Fields

Modifier and Type	Field and Description
org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
EvalScript()

Method Summary

Modifier and Type	Method and Description
org.apache.tools.ant.Task	ant(groovy.lang.Closure<?> block) Invoke an Ant block.
void	defaultTarget(String name)
void	defaultTarget(org.apache.tools.ant.Target target)
Object	evalScript(File file) Evaluate another script.
Object	evalScript(String fn) Evaluate another script.
groovy.util.AntBuilder	getAnt() Get the Ant builder.
org.apache.tools.ant.Project	getAntProject() Get the Ant project.
EvalConfig	getConfig()
EvalScriptEngine	getEngine() Get the engine in use for this script.
EvalScript	getEval() Get the evaluator script.
EvalProject	getProject() Get the eval project configured by this script.
List<String>	glob(String globPattern) Performs a file search based upon the parameter glob pattern.
List<String>	glob(String globPattern, String baseDir) Performs a file search based upon the parameter glob pattern.
Object	methodMissing(String name, Object arg)
Object	run()
void	setEngine(EvalScriptEngine ece) Set the engine this script should use.
void	setProject(EvalProject prj) Set the eval project to be configured by this script.
EvalTarget	target(String name, groovy.lang.Closure<?> closure)

Methods inherited from class groovy.lang.Script

evaluate, evaluate, getBinding, getProperty, invokeMethod, print, printf, printf, println, println, run, setBinding, setProperty

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, setMetaClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovy.lang.GroovyObject

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Field Detail

logger

public final org.slf4j.Logger logger

Constructor Detail

EvalScript

public EvalScript()

Method Detail

getConfig

public EvalConfig getConfig()

getEngine

public EvalScriptEngine getEngine()

Get the engine in use for this script.

Returns:

The script engine for this script.

setEngine

public void setEngine(EvalScriptEngine ece)

Set the engine this script should use.

Parameters:

ece - The engine to be used by this script.

getProject

public EvalProject getProject()

Get the eval project configured by this script.

Returns:

The eval project.

Throws:

IllegalStateException - if no eval project has been configured.

See Also:

setProject(EvalProject)

setProject

public void setProject(EvalProject prj)

Set the eval project to be configured by this script.

Parameters:

prj - The eval project to configure.

getEval

public EvalScript getEval()

Get the evaluator script. Provides global access to evaluator properties (such as the config).

Returns:

The eval script.

getAntProject

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

Get the Ant project.

getAnt

public groovy.util.AntBuilder getAnt()

Get the Ant builder.

ant

public org.apache.tools.ant.Task ant(groovy.lang.Closure<?> block)

Invoke an Ant block.

evalScript

public Object evalScript(File file)
                  throws IOException,
                         TaskExecutionException

Evaluate another script.

Parameters:

file - The script to evaluate.

Returns:

The return value of the script (typically the return value of its last expression).

Throws:

IOException

TaskExecutionException

evalScript

public Object evalScript(String fn)
                  throws IOException,
                         TaskExecutionException

Evaluate another script.

Parameters:

fn - The script to evaluate.

Returns:

The return value of the script (typically the return value of its last expression).

Throws:

IOException

TaskExecutionException

glob

public List<String> glob(String globPattern)

Performs a file search based upon the parameter glob pattern.

Parameters:

globPattern - String in glob syntax giving the glob to expand.

Returns:

A list of paths from the working directory to matching file names.

glob

public List<String> glob(String globPattern,
                         String baseDir)

Performs a file search based upon the parameter glob pattern.

Parameters:

globPattern - String in glob syntax giving the glob to expand.

baseDir - The base directory from which to search.

Returns:

A list of paths from the base directory matching the glob.

target

public EvalTarget target(String name,
                         @DelegatesTo(value=TargetDelegate.class,strategy=1)
                         groovy.lang.Closure<?> closure)

defaultTarget

public void defaultTarget(String name)

defaultTarget

public void defaultTarget(org.apache.tools.ant.Target target)

methodMissing

public Object methodMissing(String name,
                            Object arg)

run

public Object run()

Specified by:

run in class groovy.lang.Script