org.lenskit.data.dao.file

Interface EntityFormat

All Known Implementing Classes:

DelimitedColumnEntityFormat, JSONEntityFormat

public interface EntityFormat

Entity format interface. This is used for line-based text files.

Method Summary

Modifier and Type	Method and Description
AttributeSet	getAttributes() Get the set of attributes entities from format may have, if known.
java.lang.Class<? extends EntityBuilder>	getEntityBuilder() Get the entity builder that this format will use.
EntityType	getEntityType() Get the type of entities returned by this format.
int	getHeaderLines() Get the number of header lines this format uses.
LineEntityParser	makeParser(java.util.List<java.lang.String> header) Create an entity parser for a file.
com.fasterxml.jackson.databind.node.ObjectNode	toJSON() Create a JSON description of this entity format.

Method Detail

getEntityType

EntityType getEntityType()

Get the type of entities returned by this format.

Returns:

The type of entities returned by this format.

getAttributes

@Nullable
AttributeSet getAttributes()

Get the set of attributes entities from format may have, if known.

Returns:

The set of attributes that entities may have, or null if that information is not known.

getEntityBuilder

@Nonnull
java.lang.Class<? extends EntityBuilder> getEntityBuilder()

Get the entity builder that this format will use.

Returns:

The entity builder used by this format.

getHeaderLines

@Nonnegative
int getHeaderLines()

Get the number of header lines this format uses.

Returns:

The number of header lines to read at the beginning of the file.

makeParser

LineEntityParser makeParser(java.util.List<java.lang.String> header)

Create an entity parser for a file.

Parameters:

header - The header lines.

Returns:

A parser that will make entity lines from entities.

toJSON

com.fasterxml.jackson.databind.node.ObjectNode toJSON()

Create a JSON description of this entity format.

Returns:

The JSON description.