es.ucm.fdi.gaia.recolibry.implementations.jcolibri

Class RecommenderJColibri

java.lang.Object

es.ucm.fdi.gaia.recolibry.implementations.jcolibri.RecommenderJColibri

All Implemented Interfaces:

es.ucm.fdi.gaia.jcolibri.cbraplications.StandardCBRApplication, RecommenderAlgorithm

public class RecommenderJColibri
extends Object
implements RecommenderAlgorithm, es.ucm.fdi.gaia.jcolibri.cbraplications.StandardCBRApplication

Class that implements a content-based recommender algorithm using jCOLIBRI framework. In this class is necessary inject the connector (is the knowledge source of the recommender system).

Version:

1.0

Author:

Jose L. Jorro-Aragoneses

Constructor Summary

Constructors

Constructor and Description
RecommenderJColibri(es.ucm.fdi.gaia.jcolibri.cbrcore.Connector connector, int kNeighbourhood, es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.GlobalSimilarityFunction globalSimFunction, List<LocalSimilarityConfiguration> configurations)

Method Summary

Modifier and Type	Method and Description
boolean	close() Method to finish and close a recommender algorithm.
void	configure()
void	cycle(es.ucm.fdi.gaia.jcolibri.cbrcore.CBRQuery query)
boolean	init() It calls the configure and preCycle methods of jColibri.
void	postCycle()
es.ucm.fdi.gaia.jcolibri.cbrcore.CBRCaseBase	preCycle()
List<RecommenderResult>	recommend(Query query) It calls the cycle method of jColibri using the query of the recommender system.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecommenderJColibri

@Inject
public RecommenderJColibri(es.ucm.fdi.gaia.jcolibri.cbrcore.Connector connector,
                                   int kNeighbourhood,
                                   es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.GlobalSimilarityFunction globalSimFunction,
                                   List<LocalSimilarityConfiguration> configurations)

Method Detail

init

public boolean init()

It calls the configure and preCycle methods of jColibri.

Specified by:

init in interface RecommenderAlgorithm

Returns:

true if there is any error from this methods. false in other cases.

recommend

public List<RecommenderResult> recommend(Query query)

It calls the cycle method of jColibri using the query of the recommender system.

Specified by:

recommend in interface RecommenderAlgorithm

Parameters:

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

Returns:

list of recommendations obtained from jColibri.

close

public boolean close()

Description copied from interface: RecommenderAlgorithm

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.

Specified by:

close in interface RecommenderAlgorithm

Returns:

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

configure

public void configure()
               throws es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

Specified by:

configure in interface es.ucm.fdi.gaia.jcolibri.cbraplications.StandardCBRApplication

Throws:

es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

cycle

public void cycle(es.ucm.fdi.gaia.jcolibri.cbrcore.CBRQuery query)
           throws es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

Specified by:

cycle in interface es.ucm.fdi.gaia.jcolibri.cbraplications.StandardCBRApplication

Throws:

es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

postCycle

public void postCycle()
               throws es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

Specified by:

postCycle in interface es.ucm.fdi.gaia.jcolibri.cbraplications.StandardCBRApplication

Throws:

es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

preCycle

public es.ucm.fdi.gaia.jcolibri.cbrcore.CBRCaseBase preCycle()
                                                      throws es.ucm.fdi.gaia.jcolibri.exception.ExecutionException

Specified by:

preCycle in interface es.ucm.fdi.gaia.jcolibri.cbraplications.StandardCBRApplication

Throws:

es.ucm.fdi.gaia.jcolibri.exception.ExecutionException