org.lenskit.data.entities

Class AbstractEntity

java.lang.Object

org.lenskit.data.entities.AbstractEntity

All Implemented Interfaces:

Entity, Describable

Direct Known Subclasses:

AbstractBeanEntity

public abstract class AbstractEntity
extends java.lang.Object
implements Entity, Describable

Base class to make it easier to implement entities.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEntity(EntityType t, long eid)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asMap() View this entity as a map.
void	describeTo(DescriptionWriter writer) Write this class’s description to a sink.
boolean	equals(java.lang.Object obj)
java.lang.Object	get(java.lang.String attr) Get the value of an attribute by name.
<T> T	get(TypedName<T> name) Get the value of an attribute.
java.util.Set<java.lang.String>	getAttributeNames() Get the names of the attributes in this entity.
java.util.Collection<Attribute<?>>	getAttributes() Get the attribute-value pairs.
boolean	getBoolean(TypedName<java.lang.Boolean> name) Get the value of a attr that contains a boolean.
double	getDouble(TypedName<java.lang.Double> name) Get the value of a attr that contains a double.
long	getId() Get the identifier of this entity.
int	getInteger(TypedName<java.lang.Integer> name) Get the value of a attr that contains a int.
long	getLong(TypedName<java.lang.Long> name) Get the value of a attribute that contains a long.
EntityType	getType() Get the type of this entity.
boolean	hasAttribute(TypedName<?> name) Check if the entity has a attribute.
int	hashCode()
<T> T	maybeGet(TypedName<T> name) Get the value of a possibly-missing attribute.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lenskit.data.entities.Entity

getTypedAttributeNames, hasAttribute, maybeGet

Field Detail

type

protected final EntityType type

id

protected final long id

Constructor Detail

AbstractEntity

protected AbstractEntity(EntityType t,
                         long eid)

Method Detail

getId

@EntityAttribute(value="id")
public long getId()

Description copied from interface: Entity

Get the identifier of this entity.

Specified by:

getId in interface Entity

Returns:

The entity identifier.

getType

public EntityType getType()

Description copied from interface: Entity

Get the type of this entity.

Specified by:

getType in interface Entity

Returns:

The entity’s type.

hasAttribute

public boolean hasAttribute(TypedName<?> name)

Check if the entity has a attribute.

This implementation delegates to Entity.hasAttribute(String)

Specified by:

hasAttribute in interface Entity

Parameters:

name - The attribute name to look for.

Returns:

true if the entity contains attribute and the value is of the associated type.

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Get the names of the attributes in this entity.

Delegates to Entity.getTypedAttributeNames() and extracts the names.

Specified by:

getAttributeNames in interface Entity

getAttributes

public java.util.Collection<Attribute<?>> getAttributes()

Get the attribute-value pairs.

Delegates to Entity.getTypedAttributeNames() and extracts the names.

Specified by:

getAttributes in interface Entity

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap()

Description copied from interface: Entity

View this entity as a map.

Specified by:

asMap in interface Entity

Returns:

A map reflecting the entity’s data.

get

@Nonnull
public <T> T get(TypedName<T> name)

Get the value of an attribute.

This implementation delegates to maybeGet(TypedName).

Specified by:

get in interface Entity

Parameters:

name - The attribute name.

Returns:

The attribute’s value.

get

@Nonnull
public java.lang.Object get(java.lang.String attr)

Get the value of an attribute by name.

This implementation delegates to Entity.maybeGet(String).

Specified by:

get in interface Entity

Parameters:

attr - The attribute name.

Returns:

The attribute value.

getLong

public long getLong(TypedName<java.lang.Long> name)

Get the value of a attribute that contains a long.

This implementation delegates to get(TypedName).

Specified by:

getLong in interface Entity

Parameters:

name - The attribute name.

Returns:

The attribute’s value.

getDouble

public double getDouble(TypedName<java.lang.Double> name)

Get the value of a attr that contains a double.

This implementation delegates to get(TypedName).

Specified by:

getDouble in interface Entity

Parameters:

name - The attribute name.

Returns:

The attribute’s value.

getInteger

public int getInteger(TypedName<java.lang.Integer> name)

Get the value of a attr that contains a int.

This implementation delegates to get(TypedName).

Specified by:

getInteger in interface Entity

Parameters:

name - The attribute name.

Returns:

The attribute’s value.

getBoolean

public boolean getBoolean(TypedName<java.lang.Boolean> name)

Get the value of a attr that contains a boolean.

This implementation delegates to get(TypedName).

Specified by:

getBoolean in interface Entity

Parameters:

name - The attribute name.

Returns:

The attribute’s value.

maybeGet

@Nullable
public <T> T maybeGet(TypedName<T> name)

Get the value of a possibly-missing attribute.

This implementation delegates to Entity.maybeGet(String) and checks the type.

Specified by:

maybeGet in interface Entity

Parameters:

name - The attribute name.

Returns:

The attribute’s value, or null if it is not present.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

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.