StaticDataSource (LensKit 3.0-SNAPSHOT)

java.lang.Object
- org.lenskit.data.dao.file.StaticDataSource

All Implemented Interfaces:

javax.inject.Provider<DataAccessObject>, Describable
```
public class StaticDataSource
extends java.lang.Object
implements javax.inject.Provider<DataAccessObject>, Describable
```
Layout and builder for DAOs backed by static files. This is used to read CSV files and the like; it controls a composite DAO that reads from files, caches them in memory, and can compute some derived entities from others (e.g. extracting items from the item IDs in a rating data set).

Constructor Summary

Constructors
Constructor and Description

StaticDataSource()
Construct a new data layout object.

StaticDataSource(java.lang.String name)
Construct a new data layout object.

Constructors
Constructor and Description
`StaticDataSource()` Construct a new data layout object.
`StaticDataSource(java.lang.String name)` Construct a new data layout object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDerivedEntity(EntityDerivation deriv)` Add a derived entity to the data source.
`void`	`addDerivedEntity(EntityType derived, EntityType source, TypedName<java.lang.Long> attr)` Add a derived entity to the data source.
`void`	`addIndex(EntityType type, TypedName<?> attr)` Index entities by an attribute.
`void`	`addSource(java.util.Collection<? extends Entity> data)` Add a collection data source.
`void`	`addSource(java.util.Collection<? extends Entity> data, java.util.Map<java.lang.String,java.lang.Object> metadata)` Add a collection data source.
`void`	`addSource(EntitySource source)` Add an entity source.
`static StaticDataSource`	`csvRatingFile(java.nio.file.Path file)` Create a static data source from a CSV rating file.
`void`	`describeTo(DescriptionWriter writer)` Write this class’s description to a sink.
`static StaticDataSource`	`fromJSON(com.fasterxml.jackson.databind.JsonNode object, java.net.URI base)` Parse a JSON description of a data set.
`static StaticDataSource`	`fromJSON(java.lang.String name, com.fasterxml.jackson.databind.JsonNode object, java.net.URI base)` Parse a JSON description of a data set.
`static StaticDataSource`	`fromList(java.util.Collection<? extends Entity> entities)` Create a static data source from a list/collection.
`DataAccessObject`	`get()` Get the data access object.
`java.lang.String`	`getName()` Get the name of this source.
`PreferenceDomain`	`getPreferenceDomain()`
`java.util.List<EntitySource>`	`getSources()` Get the list of entity sources.
`java.util.List<EntitySource>`	`getSourcesForType(EntityType type)` Get the entity sources producing a particular type.
`static StaticDataSource`	`load(java.nio.file.Path path)` Load a static file data set from a file.
`static StaticDataSource`	`load(java.nio.file.Path path, java.lang.String name)` Load a static file data set from a file.
`static StaticDataSource`	`load(java.net.URI uri, java.lang.String name)` Load a static file data set from a URI.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StaticDataSource
```
public StaticDataSource()
```
    Construct a new data layout object.
  - StaticDataSource
```
public StaticDataSource(java.lang.String name)
```
    Construct a new data layout object.
    
    Parameters:
    
    name - The name of the data source.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Get the name of this source.
    
    Returns:
    
    The source name.
  - addSource
```
public void addSource(java.util.Collection<? extends Entity> data)
```
    Add a collection data source.
    
    Parameters:
    
    data - The entities to add.
  - addSource
```
public void addSource(java.util.Collection<? extends Entity> data,
                      java.util.Map<java.lang.String,java.lang.Object> metadata)
```
    Add a collection data source.
    
    Parameters:
    
    data - The entities to add.
    
    metadata - The entity source metadata.
  - addSource
```
public void addSource(EntitySource source)
```
    Add an entity source.
    
    Parameters:
    
    source - The entity source to add.
  - addIndex
```
public void addIndex(EntityType type,
                     TypedName<?> attr)
```
    Index entities by an attribute.
    
    Parameters:
    
    type - The entity type to index.
    
    attr - The attribute to index.
  - addDerivedEntity
```
public void addDerivedEntity(EntityType derived,
                             EntityType source,
                             TypedName<java.lang.Long> attr)
```
    Add a derived entity to the data source. Derived entities are synthesized from IDs found in attributes of other entities (effectively foreign keys). This allows for things such as extracting the set of users or items from a file of ratings.
    The derived entities will not overwrite entities from other sources with the same ID.
    
    Parameters:
    
    derived - The derived entity type.
    
    source - The type from which to derive it.
    
    attr - The attribute to derive the entity type from.
  - addDerivedEntity
```
public void addDerivedEntity(EntityDerivation deriv)
```
    Add a derived entity to the data source. Derived entities are synthesized from IDs found in attributes of other entities (effectively foreign keys). This allows for things such as extracting the set of users or items from a file of ratings.
    The derived entities will not overwrite entities from other sources with the same ID.
    
    Parameters:
    
    deriv - The entity derivation.
  - getSources
```
public java.util.List<EntitySource> getSources()
```
    Get the list of entity sources.
    
    Returns:
    
    The list of entity sources.
  - getSourcesForType
```
@Nonnull
public java.util.List<EntitySource> getSourcesForType(EntityType type)
```
    Get the entity sources producing a particular type.
    
    Parameters:
    
    type - The entity type to look for.
    
    Returns:
    
    A list of sources producing entities of type type.
  - get
```
public DataAccessObject get()
```
    Get the data access object. This method is thread-safe.
    
    Specified by:
    
    get in interface javax.inject.Provider<DataAccessObject>
    
    Returns:
    
    The access object.
  - getPreferenceDomain
```
@Nullable
public PreferenceDomain getPreferenceDomain()
```
  - 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.
  - fromJSON
```
public static StaticDataSource fromJSON(com.fasterxml.jackson.databind.JsonNode object,
                                        java.net.URI base)
```
    Parse a JSON description of a data set.
    
    Parameters:
    
    object - The JSON object.
    
    Returns:
    
    A DAO provider configured from the JSON data.
  - fromJSON
```
public static StaticDataSource fromJSON(java.lang.String name,
                                        com.fasterxml.jackson.databind.JsonNode object,
                                        java.net.URI base)
```
    Parse a JSON description of a data set.
    
    Parameters:
    
    object - The JSON object.
    
    Returns:
    
    A DAO provider configured from the JSON data.
  - load
```
public static StaticDataSource load(java.nio.file.Path path)
                             throws java.io.IOException
```
    Load a static file data set from a file.
    
    Parameters:
    
    path - The file to load.
    
    Returns:
    
    The data source.
    
    Throws:
    
    java.io.IOException - If there is an error loading the data source.
  - load
```
public static StaticDataSource load(java.nio.file.Path path,
                                    java.lang.String name)
                             throws java.io.IOException
```
    Load a static file data set from a file.
    
    Parameters:
    
    path - The file to load.
    
    name - The source name.
    
    Returns:
    
    The data source.
    
    Throws:
    
    java.io.IOException - If there is an error loading the data source.
  - load
```
public static StaticDataSource load(java.net.URI uri,
                                    java.lang.String name)
                             throws java.io.IOException
```
    Load a static file data set from a URI.
    
    Parameters:
    
    uri - The URI to load.
    
    name - The source name.
    
    Returns:
    
    The data source.
    
    Throws:
    
    java.io.IOException - If there is an error loading the data source.
  - csvRatingFile
```
public static StaticDataSource csvRatingFile(java.nio.file.Path file)
```
    Create a static data source from a CSV rating file.
    
    Parameters:
    
    file - The CSV rating file.
    
    Returns:
    
    The data source.
  - fromList
```
public static StaticDataSource fromList(java.util.Collection<? extends Entity> entities)
```
    Create a static data source from a list/collection.
    
    Parameters:
    
    entities - The collection of entities.
    
    Returns:
    
    The static data source.

Class StaticDataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StaticDataSource

StaticDataSource

Method Detail

getName

addSource

addSource

addSource

addIndex

addDerivedEntity

addDerivedEntity

getSources

getSourcesForType

get

getPreferenceDomain

toString

describeTo

fromJSON

fromJSON

load

load

load

csvRatingFile

fromList