org.grouplens.lenskit.data.text

Class DelimitedColumnEventFormat

java.lang.Object

org.grouplens.lenskit.data.text.DelimitedColumnEventFormat

All Implemented Interfaces:

EventFormat

public final class DelimitedColumnEventFormat
extends Object
implements EventFormat

Read events from delimited columns (CSV, TSV, etc.).

Since:

2.2

Constructor Summary

Constructors

Constructor and Description
DelimitedColumnEventFormat(EventTypeDefinition etd)

Method Summary

Modifier and Type	Method and Description
static DelimitedColumnEventFormat	create(EventTypeDefinition etd) Create a new delimited column format.
static DelimitedColumnEventFormat	create(String typeName) Create a new delimited column format from a named type.
static DelimitedColumnEventFormat	create(String typeName, ClassLoader loader) Create a new delimited column format from a named type.
String	getDelimiter()
EventTypeDefinition	getEventTypeDefinition()
List<Field>	getFields() Get the field list.
int	getHeaderLines() Get the number of header lines to skip in the file.
Object	newContext() Create a new context that may speed up parsing.
Event	parse(String line) Parse a line into an event.
Event	parse(String line, Object context) Parse using a context.
DelimitedColumnEventFormat	setDelimiter(String delim)
DelimitedColumnEventFormat	setFields(Field... fields) Set the fields to be parsed.
DelimitedColumnEventFormat	setFields(List<Field> fields) Set the fields to be parsed.
DelimitedColumnEventFormat	setHeaderLines(int lines) Set the number of lines to skip before reading events.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedColumnEventFormat

@Inject
public DelimitedColumnEventFormat(@Nonnull
                                          EventTypeDefinition etd)

Method Detail

create

@Nonnull
public static DelimitedColumnEventFormat create(@Nonnull
                                                         EventTypeDefinition etd)

Create a new delimited column format.

Parameters:

etd - The event type definition.

Returns:

The column format.

create

@Nonnull
public static DelimitedColumnEventFormat create(String typeName)

Create a new delimited column format from a named type.

Parameters:

typeName - The name of the type definition.

Returns:

The column format.

Throws:

IllegalArgumentException - if the specified type cannot be found.

create

@Nonnull
public static DelimitedColumnEventFormat create(String typeName,
                                                         ClassLoader loader)

Create a new delimited column format from a named type.

Parameters:

typeName - The name of the type definition.

loader - The class loader to load from.

Returns:

The column format.

Throws:

IllegalArgumentException - if the specified type cannot be found.

getEventTypeDefinition

@Nonnull
public EventTypeDefinition getEventTypeDefinition()

getDelimiter

@Nonnull
public String getDelimiter()

setDelimiter

public DelimitedColumnEventFormat setDelimiter(@Nonnull
                                               String delim)

getHeaderLines

public int getHeaderLines()

Description copied from interface: EventFormat

Get the number of header lines to skip in the file.

Specified by:

getHeaderLines in interface EventFormat

setHeaderLines

public DelimitedColumnEventFormat setHeaderLines(int lines)

Set the number of lines to skip before reading events.

Parameters:

lines - The number of lines to skip.

Returns:

The number of header lines to skip.

setFields

public DelimitedColumnEventFormat setFields(@Nonnull
                                            Field... fields)

Set the fields to be parsed.

Parameters:

fields - The fields to be parsed by this format.

Returns:

The format (for chaining).

setFields

public DelimitedColumnEventFormat setFields(@Nonnull
                                            List<Field> fields)

Set the fields to be parsed.

Parameters:

fields - The fields to be parsed by this format.

Returns:

The format (for chaining).

getFields

public List<Field> getFields()

Get the field list.

Returns:

The list of fields.

parse

public Event parse(String line)
            throws InvalidRowException

Description copied from interface: EventFormat

Parse a line into an event.

Specified by:

parse in interface EventFormat

Parameters:

line - The line to parse.

Returns:

The event resulting from parsing the line.

Throws:

InvalidRowException

newContext

public Object newContext()

Description copied from interface: EventFormat

Create a new context that may speed up parsing. This will be passed to EventFormat.parse(String, Object); will usually be a builder to be reused.

The context will only ever be used from one thread.

Specified by:

newContext in interface EventFormat

Returns:

The context.

parse

public Event parse(String line,
                   Object context)
            throws InvalidRowException

Description copied from interface: EventFormat

Parse using a context.

Specified by:

parse in interface EventFormat

Parameters:

line - The line to parse.

context - The parsing context.

Returns:

Throws:

InvalidRowException