org.lenskit.data.entities

Class EntityBuilder

java.lang.Object

org.lenskit.data.entities.EntityBuilder

Direct Known Subclasses:

AbstractBeanEntityBuilder, BasicEntityBuilder

public abstract class EntityBuilder
extends java.lang.Object

Base class for entity builders. The standard implementation is BasicEntityBuilder, which can be created with Entities.newBuilder(EntityType).

Field Summary

Fields

Modifier and Type	Field and Description
protected long	id
protected boolean	idSet
protected EntityType	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityBuilder(EntityType typ) Construct a new entity builder.

Method Summary

Modifier and Type	Method and Description
abstract Entity	build() Build the entity.
abstract EntityBuilder	clearAttribute(TypedName<?> name) Clear an attribute.
EntityBuilder	reset() Reset this entity builder, clearing all properties except the entity type.
<T> EntityBuilder	setAttribute(Attribute<T> attr) Set an attribute in the entity.
abstract <T> EntityBuilder	setAttribute(TypedName<T> name, T val) Set an attribute in the entity.
EntityBuilder	setDoubleAttribute(TypedName<java.lang.Double> name, double val) Set an attribute in the entity.
EntityBuilder	setId(long eid) Set the entity id.
EntityBuilder	setLongAttribute(TypedName<java.lang.Long> name, long val) Set an attribute in the entity.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final EntityType type

id

protected long id

idSet

protected boolean idSet

Constructor Detail

EntityBuilder

protected EntityBuilder(EntityType typ)

Construct a new entity builder.

Parameters:

typ - The entity type.

Method Detail

setId

public EntityBuilder setId(long eid)

Set the entity id.

Parameters:

eid - The entity id.

Returns:

The entity builder (for chaining).

setAttribute

public abstract <T> EntityBuilder setAttribute(TypedName<T> name,
                                               T val)

Set an attribute in the entity.

Parameters:

name - The name of the attribute to set.

val - The attribute value.

T - The attribute type.

Returns:

The entity builder (for chaining).

Throws:

NoSuchAttributeException - if the specified attribute is not supported by this entity.

setAttribute

public <T> EntityBuilder setAttribute(Attribute<T> attr)

Set an attribute in the entity.

Parameters:

attr - The attribute to set.

T - The attribute type.

Returns:

The entity builder (for chaining).

Throws:

NoSuchAttributeException - if the specified attribute is not supported by this entity.

setLongAttribute

public EntityBuilder setLongAttribute(TypedName<java.lang.Long> name,
                                      long val)

Set an attribute in the entity.

Parameters:

name - The name of the attribute to set.

val - The attribute value.

Returns:

The entity builder (for chaining).

Throws:

NoSuchAttributeException - if the specified attribute is not supported by this entity.

setDoubleAttribute

public EntityBuilder setDoubleAttribute(TypedName<java.lang.Double> name,
                                        double val)

Set an attribute in the entity.

Parameters:

name - The name of the attribute to set.

val - The attribute value.

Returns:

The entity builder (for chaining).

Throws:

NoSuchAttributeException - if the specified attribute is not supported by this entity.

clearAttribute

public abstract EntityBuilder clearAttribute(TypedName<?> name)

Clear an attribute.

Parameters:

name - The name of the attribute to clear.

Returns:

The entity builder (for chaining).

reset

@OverridingMethodsMustInvokeSuper
public EntityBuilder reset()

Reset this entity builder, clearing all properties except the entity type.

Returns:

The builder (for chaining).

build

public abstract Entity build()

Build the entity.

Returns:

The entity to build.