org.lenskit.data.ratings

Class InteractionStatistics

java.lang.Object

org.lenskit.data.ratings.InteractionStatistics

All Implemented Interfaces:

java.io.Serializable

@Shareable
 @Immutable
 @DefaultProvider(value=InteractionStatistics.ISProvider.class)
public class InteractionStatistics
extends java.lang.Object
implements java.io.Serializable

Interaction statistics, counting the number of times an item has been interacted with. The interaction entity must have CommonAttributes.ITEM_ID attributes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InteractionStatistics.CountSumISProvider Provider that counts item interactions.
static class	InteractionStatistics.ISProvider Provider that counts item interactions.

Constructor Summary

Constructors

Constructor and Description
InteractionStatistics(EntityType type, Long2IntMap counts) Construct a new interaction statistics object.

Method Summary

Modifier and Type	Method and Description
static InteractionStatistics	create(DataAccessObject dao) Construct a new interaction statistics object that counts ratings.
static InteractionStatistics	create(DataAccessObject dao, EntityType type) Construct a new interaction statistics object.
EntityType	getEntityType() Get the interaction entity type.
int	getInteractionCount(long item) Get the number of interactions for an item.
LongList	getItemsByPopularity() Get the list of items by decreasing popularity.
LongSortedSet	getKnownItems() Get the set of known items.

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractionStatistics

public InteractionStatistics(EntityType type,
                             Long2IntMap counts)

Construct a new interaction statistics object.

Parameters:

type - The counted entity type.

counts - A map of item interaction counts.

Method Detail

create

public static InteractionStatistics create(DataAccessObject dao,
                                           EntityType type)

Construct a new interaction statistics object.

Parameters:

dao - The DAO.

type - The entity type to count.

Returns:

The statistics.

create

public static InteractionStatistics create(DataAccessObject dao)

Construct a new interaction statistics object that counts ratings.

Parameters:

dao - The DAO.

Returns:

The rating statistics.

getEntityType

public EntityType getEntityType()

Get the interaction entity type.

Returns:

The type of entities counted for this statistics object.

getInteractionCount

public int getInteractionCount(long item)

Get the number of interactions for an item.

Parameters:

item - The item.

Returns:

The number of interactions for item.

getKnownItems

public LongSortedSet getKnownItems()

Get the set of known items.

Returns:

The set of known items.

getItemsByPopularity

public LongList getItemsByPopularity()

Get the list of items by decreasing popularity.

Returns:

The list of items, ordered by non-increasing popularity.