org.grouplens.lenskit.data.text

Interface EventTypeDefinition

All Known Implementing Classes:

LikeBatchEventType, LikeEventType, RatingEventType

public interface EventTypeDefinition

Definition for an event type that can be used to load it from a file. Implementations of this class should register themselves with the Java ServiceLoader framework to be usable from the command line, data specification files, etc.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
Class<? extends EventBuilder>	getBuilderType() Get the builder type used by this type definition.
List<Field>	getDefaultFields() Get the default field list for loading this event from text fields.
String	getName() A simple name for this event
Set<Field>	getRequiredFields() Get the set of required fields for this event type.
EventBuilder	newBuilder() Construct a new builder for this event type.

Method Detail

getName

String getName()

A simple name for this event

Returns:

The name of this event type (used to refer to it from various UI entry points).

getBuilderType

Class<? extends EventBuilder> getBuilderType()

Get the builder type used by this type definition.

newBuilder

EventBuilder newBuilder()

Construct a new builder for this event type.

Returns:

The builder.

getRequiredFields

Set<Field> getRequiredFields()

Get the set of required fields for this event type.

Returns:

The fields without which events cannot be built.

getDefaultFields

List<Field> getDefaultFields()

Get the default field list for loading this event from text fields.

Returns:

The default field list for parsing events of this type.