org.grouplens.lenskit.eval.data.pack

Class PackTask

java.lang.Object

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

org.grouplens.lenskit.eval.AbstractTask<List<Object>>

org.grouplens.lenskit.eval.data.pack.PackTask

All Implemented Interfaces:

ListenableFuture<List<Object>>, Future<List<Object>>, EvalTask<List<Object>>

public class PackTask
extends AbstractTask<List<Object>>

Pack data sets. This task returns a list of the data sets. It can pack both data sources and train-test data sets, in which case it packs the test and training data. It returns the packed data sets.

Since:

2.1

Constructor Summary

Constructors

Constructor and Description
PackTask()

Method Summary

Modifier and Type	Method and Description
void	addDataset(DataSource data)
void	addDataset(TTDataSet data)
boolean	getIncludeTimestamps() Get whether to include timestamps.
protected List<Object>	perform()
void	setIncludeTimestamps(boolean include) Set whether to include timestamps.
void	setOutputFile(Function<DataSource,File> func) Set the function to produce the default files for each data source.

Methods inherited from class org.grouplens.lenskit.eval.AbstractTask

execute, getName, getProject, setName, setProject

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

PackTask

public PackTask()

Method Detail

addDataset

public void addDataset(TTDataSet data)

addDataset

public void addDataset(DataSource data)

setIncludeTimestamps

public void setIncludeTimestamps(boolean include)

Set whether to include timestamps.

Parameters:

include - If true (the default), timestamps will be packed.

getIncludeTimestamps

public boolean getIncludeTimestamps()

Get whether to include timestamps.

Returns:

Whether or not timestamps will be included.

setOutputFile

public void setOutputFile(Function<DataSource,File> func)

Set the function to produce the default files for each data source. The function will take data sources and produce the files into which they should be packed. The default function packs CSV data sources into binary files next to their source files, and other data sources into files with unique names in the pack directory.

Parameters:

func - The function.

perform

protected List<Object> perform()
                        throws TaskExecutionException,
                               InterruptedException

Specified by:

perform in class AbstractTask<List<Object>>

Throws:

TaskExecutionException

InterruptedException