org.grouplens.lenskit.data.text

Interface EventFormat

All Known Implementing Classes:

DelimitedColumnEventFormat

public interface EventFormat

Description of how an event is laid out in a line in a text file.

In addition to a plain parsing method, this class provides some additional methods to allow objects and/or builders to be reused for more efficient data file parsing.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getHeaderLines

int getHeaderLines()

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

parse

Event parse(String line)
     throws InvalidRowException

Parse a line into an event.

Parameters:

line - The line to parse.

Returns:

The event resulting from parsing the line.

Throws:

InvalidRowException

newContext

Object newContext()

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

The context will only ever be used from one thread.

Returns:

The context.

parse

Event parse(String line,
            Object context)
     throws InvalidRowException

Parse using a context.

Parameters:

line - The line to parse.

context - The parsing context.

Returns:

Throws:

InvalidRowException