org.lenskit.data.dao.file

Interface EntitySource

All Known Implementing Classes:

TextEntitySource

public interface EntitySource

Interface for entity providers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EntitySource.Layout The layout of an entity source.

Method Summary

Modifier and Type	Method and Description
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 entity source.
java.util.Set<EntityType>	getTypes() Get the entity types produced by this source.
ObjectStream<Entity>	openStream() Get the data from this entity source.

Method Detail

getName

@Nonnull
java.lang.String getName()

Get the name of this entity source.

Returns:

The entity source name.

getTypes

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

Get the entity types produced by this source.

Returns:

The set of entity types produced by this source.

getLayout

@Nullable
EntitySource.Layout getLayout()

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.

Returns:

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

openStream

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

Get the data from this entity source.

Returns:

The data from the entity source.

Throws:

java.io.IOException

getMetadata

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

Get metadata from this entity source.