org.grouplens.lenskit.eval

Class AbstractTask<T>

java.lang.Object

com.google.common.util.concurrent.AbstractFuture<T>

org.grouplens.lenskit.eval.AbstractTask<T>

All Implemented Interfaces:

ListenableFuture<T>, Future<T>, EvalTask<T>

Direct Known Subclasses:

CrossfoldTask, DumpGraphTask, GroovyActionTask, PackTask, SubsampleTask, TrainModelTask, TrainTestEvalTask

public abstract class AbstractTask<T>
extends AbstractFuture<T>
implements EvalTask<T>

Base class to simplify writing EvalTasks.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTask() Initialize a command with no name.
protected	AbstractTask(String name) Initialize a command.

Method Summary

Modifier and Type	Method and Description
void	execute() Execute the task.
String	getName() Get the task's name.
EvalProject	getProject()
protected abstract T	perform()
AbstractTask<T>	setName(String name) Set this command's name.
AbstractTask<T>	setProject(EvalProject ep) Set the project this task is a member of.

Methods inherited from class com.google.common.util.concurrent.AbstractFuture

addListener, cancel, get, get, interruptTask, isCancelled, isDone, set, setException, wasInterrupted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

addListener

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Constructor Detail

AbstractTask

protected AbstractTask()

Initialize a command with no name.

AbstractTask

protected AbstractTask(@Nullable
                       String name)

Initialize a command.

Parameters:

name - The command's name.

Method Detail

setProject

public AbstractTask<T> setProject(@Nonnull
                                  EvalProject ep)

Set the project this task is a member of. The evaluation framework automatically calls this method, it is not necessary to call it manually.

Parameters:

ep - The eval project.

Returns:

The command (for chaining).

getProject

@Nonnull
public EvalProject getProject()

setName

public AbstractTask<T> setName(@Nullable
                               String name)

Set this command's name.

Parameters:

name - The new name.

Returns:

The command (for chaining).

getName

@Nullable
public String getName()

Get the task's name.

execute

public void execute()
             throws TaskExecutionException

Execute the task. This calls perform(), exposing the return value (or exception) as the task's value.

Specified by:

execute in interface EvalTask<T>

Throws:

TaskExecutionException - if there is an error performing the task.

perform

protected abstract T perform()
                      throws TaskExecutionException,
                             InterruptedException

Throws:

TaskExecutionException

InterruptedException