com.github.svstoll.csccrecommender.recommender

Class CsccRecommender

java.lang.Object

com.github.svstoll.csccrecommender.recommender.CsccRecommender

public class CsccRecommender
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CsccRecommender(MethodInvocationIndex methodInvocationIndex, ContextExtractor contextExtractor)

Method Summary

Modifier and Type	Method and Description
void	recommendForAllInvocationsInAvailableContexts(ContextEvaluationStatistics statistics) Uses the specified index directory to perform a recommendation for every method invocation within the projects provided in the contexts dataset.
List<RecommendationResult>	recommendMethods(cc.kave.commons.model.events.completionevents.CompletionEvent completionEvent) Recommend method names for a given KaVe method completion event based on the specified index directory.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Detail

CsccRecommender

@Inject
protected CsccRecommender(MethodInvocationIndex methodInvocationIndex,
                                  ContextExtractor contextExtractor)

Method Detail

recommendMethods

public List<RecommendationResult> recommendMethods(cc.kave.commons.model.events.completionevents.CompletionEvent completionEvent)

Recommend method names for a given KaVe method completion event based on the specified index directory.

Parameters:

completionEvent - a KaVE method completion event.

Returns:

a ranked list of method name recommendations.

Throws:

IllegalStateException - if the last selected proposal of the completion event is null or is not a IMethodName.

recommendForAllInvocationsInAvailableContexts

public void recommendForAllInvocationsInAvailableContexts(ContextEvaluationStatistics statistics)

Uses the specified index directory to perform a recommendation for every method invocation within the projects provided in the contexts dataset.

Parameters:

statistics - used to log overall recommendation statistics.