org.grouplens.lenskit.data.source

Class TextDataSourceBuilder

java.lang.Object

org.grouplens.lenskit.data.source.TextDataSourceBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVDataSourceBuilder

public class TextDataSourceBuilder
extends Object
implements org.apache.commons.lang3.builder.Builder<DataSource>

Builder for text file data sources.

Since:

2.2

Constructor Summary

Constructors

Constructor and Description
TextDataSourceBuilder()
TextDataSourceBuilder(File file)
TextDataSourceBuilder(String name)

Method Summary

Modifier and Type	Method and Description
TextDataSource	build() Build the data source.
String	getDelimiter() Get the input delimiter.
PreferenceDomain	getDomain()
File	getFile() Get the input file.
EventFormat	getFormat() Get the currently-configured event format.
int	getHeaderLines() Get the number of header lines that will be skipped.
File	getItemFile() Get the item file.
File	getItemNameFile() Get the item file.
String	getName()
TextDataSourceBuilder	setDelimiter(String delim) Set the input field delimiter.
TextDataSourceBuilder	setDomain(PreferenceDomain dom) Set the preference domain for the data source.
TextDataSourceBuilder	setFile(File file) Set the input file.
TextDataSourceBuilder	setFile(String fn) Set the input file by name.
TextDataSourceBuilder	setFormat(EventFormat fmt) Set the event format.
TextDataSourceBuilder	setHeaderLines(int lines) Set the number of header lines to skip.
TextDataSourceBuilder	setItemFile(File file) Set the item ID file.
TextDataSourceBuilder	setItemNameFile(File file) Set the item ID to name mapping file.
TextDataSourceBuilder	setName(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

TextDataSourceBuilder

public TextDataSourceBuilder()

TextDataSourceBuilder

public TextDataSourceBuilder(String name)

TextDataSourceBuilder

public TextDataSourceBuilder(File file)

Method Detail

setName

public TextDataSourceBuilder setName(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(java.io.File)

getName

@Nonnull
public String getName()

getFile

public File getFile()

Get the input file.

Returns:

The input file for the builder.

setFile

public TextDataSourceBuilder setFile(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 TextDataSourceBuilder setFile(String fn)

Set the input file by name.

Parameters:

fn - The input file name.

Returns:

The builder (for chaining).

getFormat

public EventFormat getFormat()

Get the currently-configured event format.

Returns:

The configured event format.

setFormat

public TextDataSourceBuilder setFormat(EventFormat fmt)

Set the event format. This method overrides any previous calls to set the delimiter or columns, and disables any future calls.

Parameters:

fmt - The format.

Returns:

The builder (for chaining).

getDelimiter

public String getDelimiter()

Get the input delimiter.

setDelimiter

public TextDataSourceBuilder setDelimiter(String delim)

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

Parameters:

delim - The input delimiter.

Throws:

IllegalStateException - if a format has been specified with setFormat(EventFormat).

getHeaderLines

public int getHeaderLines()

Get the number of header lines that will be skipped.

Returns:

The number of header lines that will be skipped.

setHeaderLines

public TextDataSourceBuilder setHeaderLines(int lines)

Set the number of header lines to skip.

Parameters:

lines - The number of header lines to skip.

Returns:

The builder (for chaining).

getDomain

public PreferenceDomain getDomain()

setDomain

public TextDataSourceBuilder setDomain(PreferenceDomain dom)

Set the preference domain for the data source.

Parameters:

dom - The preference domain.

Returns:

The command (for chaining).

getItemFile

public File getItemFile()

Get the item file.

Returns:

The item file, if one is specified.

setItemFile

public TextDataSourceBuilder setItemFile(File file)

Set the item ID file.

Parameters:

file - The item file, if one is specified.

getItemNameFile

public File getItemNameFile()

Get the item file.

Returns:

The item file, if one is specified.

setItemNameFile

public TextDataSourceBuilder setItemNameFile(File file)

Set the item ID to name mapping file.

Parameters:

file - The item name file, if one is specified.

build

public TextDataSource build()

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

Specified by:

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

Returns:

The configured data source.