org.lenskit.api

Interface Recommender

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LenskitRecommender

public interface Recommender
extends AutoCloseable

Main entry point for accessing recommender components. A recommender object is effectively a recommender session: it is a per-thread or per-request object, likely connected to a database connection or persistence session, that needs to be closed when the client code is finished with it.

The various methods in this class return null if the corresponding operation is not supported by the underlying recommender configuration. This ensures that, if you can actually get an object implementing a particular interface, you are guaranteed to be able to use it.

See Also:

RecommenderEngine

Compatibility

Public

Method Summary

Modifier and Type	Method and Description
void	close() Close the recommender.
ItemBasedItemRecommender	getItemBasedItemRecommender() Get the recommender’s item-based item recommender.
ItemBasedItemScorer	getItemBasedItemScorer() Get the recommender’s item-based item scorer.
ItemRecommender	getItemRecommender() Get the recommender’s item recommender.
ItemScorer	getItemScorer() Get the recommender’s item scorer.
RatingPredictor	getRatingPredictor() Get the recommender’s rating scorer.

Method Detail

getRatingPredictor

@Nullable
RatingPredictor getRatingPredictor()

Get the recommender’s rating scorer.

Returns:

The rating predictor for this recommender configuration, or null if rating prediction is not supported.

getItemRecommender

@Nullable
ItemRecommender getItemRecommender()

Get the recommender’s item recommender.

Returns:

The item recommender for this recommender configuration, or null if item recommendation is not supported.

getItemScorer

@Nullable
ItemScorer getItemScorer()

Get the recommender’s item scorer.

Returns:

The item scorer for the configured recommender, or null if item scoring is not supported.

getItemBasedItemScorer

@Nullable
ItemBasedItemScorer getItemBasedItemScorer()

Get the recommender’s item-based item scorer.

Returns:

The item-based item scorer for the configured recommender, or null if basket-based scoring is not supported.

getItemBasedItemRecommender

@Nullable
ItemBasedItemRecommender getItemBasedItemRecommender()

Get the recommender’s item-based item recommender.

Returns:

The item-based item recommender for the configured recommender, or null if basket-based scoring is not supported.

close

void close()

Close the recommender. This closes underlying resources such as database collections. Components retrieved from the recommender must be used once the recommender is closed. Components capable of explicitly detecting use-after-close will indicate such invalid use by throwing IllegalStateException, although they may fail with other exceptions. The results of using a component after its recommender has been closed are formally undefined.

Specified by:

close in interface AutoCloseable