org.grouplens.lenskit.eval.data

Class CSVDataSourceBuilder

java.lang.Object

org.grouplens.lenskit.eval.data.CSVDataSourceBuilder

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<DataSource>

public class CSVDataSourceBuilder
extends java.lang.Object
implements org.apache.commons.lang3.builder.Builder<DataSource>

Command to return a CSV data source.

Constructor Summary

Constructors

Constructor and Description
CSVDataSourceBuilder()
CSVDataSourceBuilder(java.io.File file)
CSVDataSourceBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
CSVDataSource	build() Build the data source.
java.lang.String	getDelimiter() Get the input delimiter.
PreferenceDomain	getDomain()
java.io.File	getFile() Get the input file.
java.lang.String	getName()
CSVDataSourceBuilder	setCache(boolean on) Deprecated.
CSVDataSourceBuilder	setDelimiter(java.lang.String delim) Set the input field delimiter.
CSVDataSourceBuilder	setDomain(PreferenceDomain dom) Set the preference domain for the data source.
CSVDataSourceBuilder	setFile(java.io.File file) Set the input file.
CSVDataSourceBuilder	setFile(java.lang.String fn) Set the input file by name.
CSVDataSourceBuilder	setName(java.lang.String n) Set the data source name.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVDataSourceBuilder

public CSVDataSourceBuilder()

CSVDataSourceBuilder

public CSVDataSourceBuilder(java.lang.String name)

CSVDataSourceBuilder

public CSVDataSourceBuilder(java.io.File file)

Method Detail

setName

public CSVDataSourceBuilder setName(java.lang.String n)

Set the data source name. If unspecified, a name is derived from the file.

Parameters:

n - The name of the data source.

See Also:

setFile(File)

getName

@Nonnull
public java.lang.String getName()

getFile

public java.io.File getFile()

Get the input file.

Returns:

The input file for the builder.

setFile

public CSVDataSourceBuilder setFile(java.io.File file)

Set the input file. If unspecified, the name (see setName(String)) is used as the file name.

Parameters:

file - The file to read ratings from.

setFile

public CSVDataSourceBuilder setFile(java.lang.String fn)

Set the input file by name.

Parameters:

fn - The input file name.

Returns:

The builder (for chaining).

getDelimiter

public java.lang.String getDelimiter()

Get the input delimiter.

setDelimiter

public CSVDataSourceBuilder setDelimiter(java.lang.String delim)

Set the input field delimiter. The default is the tab character.

Parameters:

delim - The input delimiter.

setCache

@Deprecated
public CSVDataSourceBuilder setCache(boolean on)

Deprecated.

Specify whether to cache ratings in memory. Caching is enabled by default.

Parameters:

on - false to disable caching.

getDomain

public PreferenceDomain getDomain()

setDomain

public CSVDataSourceBuilder setDomain(PreferenceDomain dom)

Set the preference domain for the data source.

Parameters:

dom - The preference domain.

Returns:

The command (for chaining).

build

public CSVDataSource build()

Build the data source. At least one of setName(String) or setFile(File) must be called prior to building.

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<DataSource>

Returns:

The configured data source.