org.lenskit.data.store

Class EntityCollectionBuilder

java.lang.Object

org.lenskit.data.store.EntityCollectionBuilder

public abstract class EntityCollectionBuilder
extends java.lang.Object

Created by MichaelEkstrand on 4/18/2017.

Constructor Summary

Constructors

Constructor and Description
EntityCollectionBuilder()

Method Summary

Modifier and Type	Method and Description
EntityCollectionBuilder	add(Entity e) Add an entity to the collection.
abstract EntityCollectionBuilder	add(Entity e, boolean replace) Add an entity to the collection.
abstract EntityCollectionBuilder	addIndex(java.lang.String attrName) Add an index to an entity collection to speed up lookups.
abstract <T> EntityCollectionBuilder	addIndex(TypedName<T> attribute) Add an index to an entity collection to speed up lookups.
abstract EntityCollection	build() Build the entity collection.
abstract java.lang.Iterable<Entity>	entities() Get a view of the entities added, for iteration and re-processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityCollectionBuilder

public EntityCollectionBuilder()

Method Detail

addIndex

public abstract <T> EntityCollectionBuilder addIndex(TypedName<T> attribute)

Add an index to an entity collection to speed up lookups.

Parameters:

attribute - The attribute to index.

T - The attribute type

Returns:

The builder (for chaining).

addIndex

public abstract EntityCollectionBuilder addIndex(java.lang.String attrName)

Add an index to an entity collection to speed up lookups.

Parameters:

attrName - The name of the attribute to index.

Returns:

The builder (for chaining).

add

public EntityCollectionBuilder add(Entity e)

Add an entity to the collection. If an entity with the specified ID already exists, it is replaced.

Parameters:

e - The entity to add.

Returns:

The builder (for chaining).

add

public abstract EntityCollectionBuilder add(Entity e,
                                            boolean replace)

Add an entity to the collection.

Parameters:

e - The entity to add.

replace - Whether to replace. If false, and an entity with the same ID as e has already been added, this entity is silently ignored.

Returns:

The builder (for chaining).

entities

public abstract java.lang.Iterable<Entity> entities()

Get a view of the entities added, for iteration and re-processing.

Returns:

The view of entities added.

build

public abstract EntityCollection build()

Build the entity collection.

Returns:

The collection of entities.