Package de.uni_trier.wi2.procake.retrieval.impl

Class DependencyRetrieverImpl

java.lang.Object

de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

de.uni_trier.wi2.procake.utils.composition.AbstractEmptyFactoryObjectImplementation

de.uni_trier.wi2.procake.retrieval.impl.RetrieverImpl<DataObject,DependencyQuery>

de.uni_trier.wi2.procake.retrieval.impl.DependencyRetrieverImpl

All Implemented Interfaces:

DependencyRetriever, Retriever<DataObject,DependencyQuery>

public class DependencyRetrieverImpl
extends RetrieverImpl<DataObject,DependencyQuery>
implements DependencyRetriever

Implementation of DependencyRetriever.

Author:

Rahol Kumar, Alexander Schultheis

Field Summary

Fields inherited from interface de.uni_trier.wi2.procake.retrieval.DependencyRetriever

DEFAULT_ALPHA, DEFAULT_RESULT_NUMBER, NAME

Fields inherited from interface de.uni_trier.wi2.procake.retrieval.Retriever

DEFAULT_ADDQUERYTORESULTS

Constructor Summary

Constructors

Constructor	Description
DependencyRetrieverImpl()

Method Summary

Modifier and Type	Method	Description
double	getAlpha()	Method, that returns the parameter alpha, which is a weighting factor, that enables adjusting both parts of the similarity computation to individual needs of the use case.
int	getResultsNumber()	Method, that returns the parameter k for the result numbers, that defines, how many dependency full matches must be found.
String	getRetrieverName()	Method, that returns the retriever name.
DependencyQuery	newQuery()	Creates a new Query for the retriever.
DependencyRetrievalResultList	perform(DependencyQuery dependencyQuery)	Method, to perform the dependency retrieval.
void	setAlpha(double alpha)	Method, to set the parameter alpha, which is a weighting factor, that enables adjusting both parts of the similarity computation to individual needs of the use case.
void	setResultsNumber(int resultsNumber)	Method, to set the parameter k for the result numbers, that defines, how many dependency full matches must be found.

Methods inherited from class de.uni_trier.wi2.procake.retrieval.impl.RetrieverImpl

getInternalSimilarityMeasure, getObjectPool, getSimilarityCache, getSimilarityModel, getValuator, isAddQueryToResults, setAddQueryToResults, setInternalSimilarityMeasure, setObjectPool, setSimilarityCache, setSimilarityModel

Methods inherited from class de.uni_trier.wi2.procake.utils.composition.AbstractEmptyFactoryObjectImplementation

getParameters, postInit, preInit

Methods inherited from class de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

getParameter, initParametersBasedOn

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_trier.wi2.procake.retrieval.Retriever

isAddQueryToResults, setAddQueryToResults, setInternalSimilarityMeasure, setObjectPool, setSimilarityCache, setSimilarityModel

Constructor Detail

DependencyRetrieverImpl

public DependencyRetrieverImpl()

Method Detail

newQuery

public DependencyQuery newQuery()

Description copied from interface: Retriever

Creates a new Query for the retriever. Do not mix the query objects between different retrieval implementation because queries can be implementation dependent.

Specified by:

newQuery in interface DependencyRetriever

Specified by:

newQuery in interface Retriever<DataObject,DependencyQuery>

Overrides:

newQuery in class RetrieverImpl<DataObject,DependencyQuery>

Returns:

a new query object.

perform

public DependencyRetrievalResultList perform(DependencyQuery dependencyQuery)

Method, to perform the dependency retrieval. Necessary to cast the objects in method signature.

Specified by:

perform in interface DependencyRetriever

Specified by:

perform in interface Retriever<DataObject,DependencyQuery>

Parameters:

dependencyQuery - A dependency query that can be created with newQuery()

Returns:

a list of retrieval results

setResultsNumber

public void setResultsNumber(int resultsNumber)

Description copied from interface: DependencyRetriever

Method, to set the parameter k for the result numbers, that defines, how many dependency full matches must be found. If not at least k such case combinations were detected, a search of combined cases using dependency similarities is performed.

Specified by:

setResultsNumber in interface DependencyRetriever

Parameters:

resultsNumber - The parameter k defines, how many dependency full matches must be found.

getResultsNumber

public int getResultsNumber()

Description copied from interface: DependencyRetriever

Method, that returns the parameter k for the result numbers, that defines, how many dependency full matches must be found. If not at least k such case combinations were detected, a search of combined cases using dependency similarities is performed.

Specified by:

getResultsNumber in interface DependencyRetriever

Returns:

The parameter k defines, how many dependency full matches must be found.

getRetrieverName

public String getRetrieverName()

Method, that returns the retriever name.

Returns:

The name of the retriever.

setAlpha

public void setAlpha(double alpha)

Description copied from interface: DependencyRetriever

Method, to set the parameter alpha, which is a weighting factor, that enables adjusting both parts of the similarity computation to individual needs of the use case. The default weight is DependencyRetriever.DEFAULT_ALPHA.

Specified by:

setAlpha in interface DependencyRetriever

Parameters:

alpha - The weighting parameter alpha, that should be used.

getAlpha

public double getAlpha()

Description copied from interface: DependencyRetriever

Method, that returns the parameter alpha, which is a weighting factor, that enables adjusting both parts of the similarity computation to individual needs of the use case.

Specified by:

getAlpha in interface DependencyRetriever

Returns:

The weighting parameter alpha, that is used.