org.lenskit.data.dao.file

Class JSONEntityFormat

java.lang.Object

org.lenskit.data.dao.file.JSONEntityFormat

All Implemented Interfaces:

EntityFormat

public class JSONEntityFormat
extends java.lang.Object
implements EntityFormat

Entity format that decodes JSON objects.

Constructor Summary

Constructors

Constructor and Description
JSONEntityFormat()

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, TypedName<?> attr) Add an attribute to the list of expected attributes, with a JSON field name.
void	addAttribute(TypedName<?> attr) Add an attribute to the list of expected attributes.
static JSONEntityFormat	fromJSON(java.lang.String name, java.lang.ClassLoader loader, com.fasterxml.jackson.databind.JsonNode json)
AttributeSet	getAttributes() Get the set of attributes entities from format may have, if known.
java.util.Map<java.lang.String,TypedName<?>>	getDefinedAttributes() Get the attributes expected.
java.lang.Class<? extends EntityBuilder>	getEntityBuilder() Get the entity builder class.
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.
EntityBuilder	newEntityBuilder() Instantiate a new entity builder.
void	setEntityBuilder(java.lang.Class<? extends EntityBuilder> builder) Set the entity builder class.
void	setEntityType(EntityType type) Set the entity type.
com.fasterxml.jackson.databind.node.ObjectNode	toJSON() Create a JSON description of this entity format.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONEntityFormat

public JSONEntityFormat()

Method Detail

setEntityType

public void setEntityType(EntityType type)

Set the entity type.

Parameters:

type - The entity type.

getEntityType

public EntityType getEntityType()

Description copied from interface: EntityFormat

Get the type of entities returned by this format.

Specified by:

getEntityType in interface EntityFormat

Returns:

The type of entities returned by this format.

getHeaderLines

public int getHeaderLines()

Description copied from interface: EntityFormat

Get the number of header lines this format uses.

Specified by:

getHeaderLines in interface EntityFormat

Returns:

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

makeParser

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

Description copied from interface: EntityFormat

Create an entity parser for a file.

Specified by:

makeParser in interface EntityFormat

Parameters:

header - The header lines.

Returns:

A parser that will make entity lines from entities.

setEntityBuilder

public void setEntityBuilder(java.lang.Class<? extends EntityBuilder> builder)

Set the entity builder class.

Parameters:

builder - The entity builder class.

getEntityBuilder

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

Get the entity builder class.

Specified by:

getEntityBuilder in interface EntityFormat

Returns:

The entity builder class.

newEntityBuilder

public EntityBuilder newEntityBuilder()

Instantiate a new entity builder.

Returns:

A new entity builder.

getDefinedAttributes

public java.util.Map<java.lang.String,TypedName<?>> getDefinedAttributes()

Get the attributes expected.

Returns:

The expected attributes.

getAttributes

public AttributeSet getAttributes()

Description copied from interface: EntityFormat

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

Specified by:

getAttributes in interface EntityFormat

Returns:

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

addAttribute

public void addAttribute(TypedName<?> attr)

Add an attribute to the list of expected attributes. It will be parsed from the JSON object field of the same name.

Parameters:

attr - The attribute to add.

addAttribute

public void addAttribute(java.lang.String name,
                         TypedName<?> attr)

Add an attribute to the list of expected attributes, with a JSON field name.

Parameters:

name - The name of the field as it will appear in JSON.

attr - The attribute to add.

toJSON

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

Description copied from interface: EntityFormat

Create a JSON description of this entity format.

Specified by:

toJSON in interface EntityFormat

Returns:

The JSON description.

fromJSON

public static JSONEntityFormat fromJSON(java.lang.String name,
                                        java.lang.ClassLoader loader,
                                        com.fasterxml.jackson.databind.JsonNode json)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object