org.grouplens.lenskit.eval.data.subsample

Class SubsampleTask

java.lang.Object

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

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

org.grouplens.lenskit.eval.data.subsample.SubsampleTask

All Implemented Interfaces:

ListenableFuture<DataSource>, Future<DataSource>, EvalTask<DataSource>

public class SubsampleTask
extends AbstractTask<DataSource>

The command to build and run a Subsample on the data source file and output the partition files

Constructor Summary

Constructors

Constructor and Description
SubsampleTask()
SubsampleTask(String name)

Method Summary

Modifier and Type	Method and Description
double	getFraction() Get the size of file.
SubsampleMode	getMode() Get the mode of the subsample.
File	getOutput() Get the output name of subsample file.
DataSource	getSource() Get the data source backing this subsample manager.
DataSource	perform() Run the Subsample command.
SubsampleTask	setFraction(double fraction) Set the fraction of subsample to generate.
SubsampleTask	setMode(SubsampleMode mode) Set the mode of the subsample, it is user, item or rating.
SubsampleTask	setOutput(File out) Set the output file for the sampled data.
SubsampleTask	setOutput(String name) Set the output file name.
SubsampleTask	setSource(DataSource source) Set the input 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

SubsampleTask

public SubsampleTask()

SubsampleTask

public SubsampleTask(String name)

Method Detail

setFraction

public SubsampleTask setFraction(double fraction)
                          throws IllegalArgumentException

Set the fraction of subsample to generate.

Parameters:

fraction - The fraction of ratings to keep.

Returns:

The SubsampleCommand object (for chaining)

Throws:

IllegalArgumentException

setOutput

public SubsampleTask setOutput(String name)

Set the output file name.

Parameters:

name - The name of the output file.

Returns:

The subsample task (for chaining).

See Also:

setOutput(java.io.File)

setOutput

public SubsampleTask setOutput(File out)

Set the output file for the sampled data.

Parameters:

out - The output file.

Returns:

The task (for chaining).

setSource

public SubsampleTask setSource(DataSource source)

Set the input data source.

Parameters:

source - The data source to use.

Returns:

The SubsampleCommand object (for chaining)

setMode

public SubsampleTask setMode(SubsampleMode mode)

Set the mode of the subsample, it is user, item or rating.

Parameters:

mode - The mode of the output.

Returns:

The SubsampleCommand object (for chaining).

getOutput

public File getOutput()

Get the output name of subsample file.

Returns:

The output name of the subsample file.

getSource

public DataSource getSource()

Get the data source backing this subsample manager.

Returns:

The underlying data source.

getFraction

public double getFraction()

Get the size of file.

Returns:

The number of size in subsample file.

getMode

public SubsampleMode getMode()

Get the mode of the subsample.

Returns:

The mode of the subsample

perform

public DataSource perform()
                   throws TaskExecutionException

Run the Subsample command.

Specified by:

perform in class AbstractTask<DataSource>

Returns:

DataSource The subsample DataSource file

Throws:

TaskExecutionException