es.ucm.fdi.gaia.recolibry.api

Interface RecommenderAlgorithm

All Known Implementing Classes:

RecommenderJColibri, RecommenderMahoutCFItem, RecommenderMahoutCFUser

public interface RecommenderAlgorithm

This interface specifies the main structure of all recommender algorithm used in RecoLibry. This interface should be implemented when a new algorithm is introduced in RecoLibry.

Version:

1.0

Author:

Jose L. Jorro-Aragoneses

Method Summary

Modifier and Type	Method and Description
boolean	close() Method to finish and close a recommender algorithm.
boolean	init() Method to initialize a recommender algorithm.
List<RecommenderResult>	recommend(Query query) Method to calculate a recommendation in the algorithm implemented.

Method Detail

init

boolean init()

Method to initialize a recommender algorithm. For example, if the algorithm has a training step, it is implemented in this method.

Returns:

true when the algorithm is initialized correctly, false in other case.

recommend

List<RecommenderResult> recommend(Query query)

Method to calculate a recommendation in the algorithm implemented.

Parameters:

query - Query that contains the information to make a recomendation.

Returns:

List of elements recommended by the algorithm.

close

boolean close()

Method to finish and close a recommender algorithm. For example, if the algorithm needs to save a new model, it is implemented in this method.

Returns:

true when the algorithm is finished and closed correctly, false in other case.