org.lenskit.data.dao.file

Class TextEntitySource

java.lang.Object

org.lenskit.data.dao.file.TextEntitySource

All Implemented Interfaces:

EntitySource, Describable

public class TextEntitySource
extends java.lang.Object
implements EntitySource, Describable

Entity reader that loads entities from text data, often stored in a file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.lenskit.data.dao.file.EntitySource

EntitySource.Layout

Constructor Summary

Constructors

Constructor and Description
TextEntitySource() Construct a new text entity source.
TextEntitySource(java.lang.String name) Construct a new text entity source.

Method Summary

Modifier and Type	Method and Description
void	describeTo(DescriptionWriter writer) Write this class’s description to a sink.
java.nio.file.Path	getFile() Get the input file path.
EntityFormat	getFormat() Get the entity format for the reader.
EntitySource.Layout	getLayout() Get this entity source’s layout, if one is available.
java.util.Map<java.lang.String,java.lang.Object>	getMetadata() Get metadata from this entity source.
java.lang.String	getName() Get the name of this data source.
java.util.Set<EntityType>	getTypes() Get the entity types produced by this source.
java.net.URL	getURL() Get the source file for this data source.
ObjectStream<Entity>	openStream() Open a stream to read entities from this source.
void	setFile(java.nio.file.Path file) Set the source file for this reader.
void	setFormat(EntityFormat format) Set the entity format for the reader.
void	setSource(java.lang.CharSequence text) Set a string from which to read entities.
void	setURL(java.net.URL url) Set the URL of the input data.
com.fasterxml.jackson.databind.JsonNode	toJSON(java.net.URI base) Construct a JSON representation of this entity source, suitable for serialization to e.g.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextEntitySource

public TextEntitySource()

Construct a new text entity source.

TextEntitySource

public TextEntitySource(java.lang.String name)

Construct a new text entity source.

Parameters:

name - The source’s name.

Method Detail

getName

public java.lang.String getName()

Get the name of this data source.

Specified by:

getName in interface EntitySource

Returns:

The data source name.

getTypes

@Nonnull
public java.util.Set<EntityType> getTypes()

Description copied from interface: EntitySource

Get the entity types produced by this source.

Specified by:

getTypes in interface EntitySource

Returns:

The set of entity types produced by this source.

getLayout

@Nullable
public EntitySource.Layout getLayout()

Description copied from interface: EntitySource

Get this entity source’s layout, if one is available. A source has a layout if it produces a single entity type with a known set of attributes.

Specified by:

getLayout in interface EntitySource

Returns:

The layout, or null if this source does not know its layout.

setFile

public void setFile(java.nio.file.Path file)

Set the source file for this reader.

Parameters:

file - The source file.

setURL

public void setURL(java.net.URL url)

Set the URL of the input data.

Parameters:

url - The URL of the input data.

getFile

public java.nio.file.Path getFile()

Get the input file path.

Returns:

The input file path.

getURL

public java.net.URL getURL()

Get the source file for this data source.

Returns:

The source file.

setSource

public void setSource(java.lang.CharSequence text)

Set a string from which to read entities.

setFormat

public void setFormat(EntityFormat format)

Set the entity format for the reader.

Parameters:

format - The entity format.

getFormat

public EntityFormat getFormat()

Get the entity format for the reader.

Returns:

The entity format.

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

Description copied from interface: EntitySource

Get metadata from this entity source.

Specified by:

getMetadata in interface EntitySource

openStream

public ObjectStream<Entity> openStream()
                                throws java.io.IOException

Open a stream to read entities from this source.

Specified by:

openStream in interface EntitySource

Returns:

A stream of entities.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeTo

public void describeTo(DescriptionWriter writer)

Description copied from interface: Describable

Write this class’s description to a sink. Anything relevant to this object’s identity should be digested; the idea is that, barring hash collisions, two objects with the same digest are equivalent. Used for things like deterministically generating cache file names.

Specified by:

describeTo in interface Describable

Parameters:

writer - The description writer to use.

toJSON

public com.fasterxml.jackson.databind.JsonNode toJSON(@Nullable
                                                      java.net.URI base)

Construct a JSON representation of this entity source, suitable for serialization to e.g. YAML.

Parameters:

base - The URI of the YAML file that will be generated, to generate relative URLs.

Returns:

The JSON node.