org.lenskit.data.entities

Class EntityCollectionBuilder

java.lang.Object

org.lenskit.data.entities.EntityCollectionBuilder

public class EntityCollectionBuilder
extends Object

Builder class for entity collections. These builders are destructive: their build() methods destroy the internal storage, so the builder is single-use.

Constructor Summary

Constructors

Constructor and Description
EntityCollectionBuilder(EntityType type)

Method Summary

Modifier and Type	Method and Description
EntityCollectionBuilder	add(Entity e) Add an entity to the collection.
EntityCollectionBuilder	add(Entity e, boolean replace) Add an entity to the collection.
EntityCollectionBuilder	addAll(Entity... entities) Add multiple entities to the collection.
EntityCollectionBuilder	addAll(Iterable<Entity> entities) Add multiple entities to the collection.
EntityCollectionBuilder	addIndex(String attrName) Add an index to an entity collection to speed up lookups.
<T> EntityCollectionBuilder	addIndex(TypedName<T> attribute) Add an index to an entity collection to speed up lookups.
EntityCollection	build() Build the entity collection.
Collection<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(EntityType type)

Method Detail

addIndex

public <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 EntityCollectionBuilder addIndex(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.

Parameters:

e - The entity to add.

Returns:

The builder (for chaining).

add

public 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).

addAll

public EntityCollectionBuilder addAll(Entity... entities)

Add multiple entities to the collection.

Parameters:

entities - The entity to add.

Returns:

The builder (for chaining).

addAll

public EntityCollectionBuilder addAll(Iterable<Entity> entities)

Add multiple entities to the collection.

Parameters:

entities - The entity to add.

Returns:

The builder (for chaining).

entities

public Collection<Entity> entities()

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

Returns:

The view of entities added.

build

public EntityCollection build()

Build the entity collection.

Returns:

The collection of entities.