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

Class RetrieverImpl<TCase extends DataObject,TQuery extends Query>

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<TCase,TQuery>

All Implemented Interfaces:

Retriever<TCase,TQuery>

Direct Known Subclasses:

AbstractMACFACRetriever, DependencyRetrieverImpl, FeatureRetriever, GraphAStarParallelRetrieverImpl, LinearRetrieverImpl, ParallelLinearRetrieverImpl

public abstract class RetrieverImpl<TCase extends DataObject,TQuery extends Query>
extends AbstractEmptyFactoryObjectImplementation
implements Retriever<TCase,TQuery>

Field Summary

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

DEFAULT_ADDQUERYTORESULTS

Constructor Summary

Constructors

Constructor	Description
RetrieverImpl()

Method Summary

Modifier and Type	Method	Description
protected String	getInternalSimilarityMeasure()
protected ReadableObjectPool<TCase>	getObjectPool()
SimilarityCache	getSimilarityCache()
protected SimilarityModel	getSimilarityModel()
protected SimilarityValuator	getValuator()
boolean	isAddQueryToResults()	Checks whether the retriever is instructed to add the query to the RetrievalResultList
TQuery	newQuery()	Creates a new Query for the retriever.
void	setAddQueryToResults(boolean addQueryToResults)	Instructs retriever to add the query to the RetrievalResultList depending on addQueryToResults
void	setInternalSimilarityMeasure(String internalSimilarityMeasure)	Sets internal similarity measure that is used to compute similarity
void	setObjectPool(ReadableObjectPool pool)	Sets the object pool.
void	setSimilarityCache(SimilarityCache similarityCache)	Sets the similarity cache.
void	setSimilarityModel(SimilarityModel model)	Sets the similarity model.

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

perform

Constructor Detail

RetrieverImpl

public RetrieverImpl()

Method Detail

getSimilarityCache

public SimilarityCache getSimilarityCache()

setSimilarityCache

public void setSimilarityCache(SimilarityCache similarityCache)

Description copied from interface: Retriever

Sets the similarity cache. By default, it is null.

Specified by:

setSimilarityCache in interface Retriever<TCase extends DataObject,TQuery extends Query>

getObjectPool

protected ReadableObjectPool<TCase> getObjectPool()

Returns:

Returns the used case base.

setObjectPool

public void setObjectPool(ReadableObjectPool pool)

Description copied from interface: Retriever

Sets the object pool.

Specified by:

setObjectPool in interface Retriever<TCase extends DataObject,TQuery extends Query>

getInternalSimilarityMeasure

protected String getInternalSimilarityMeasure()

Returns:

Returns the internal similarity measure.

setInternalSimilarityMeasure

public void setInternalSimilarityMeasure(String internalSimilarityMeasure)

Description copied from interface: Retriever

Sets internal similarity measure that is used to compute similarity

Specified by:

setInternalSimilarityMeasure in interface Retriever<TCase extends DataObject,TQuery extends Query>

getSimilarityModel

protected SimilarityModel getSimilarityModel()

Returns:

Returns the used similarity model.

setSimilarityModel

public void setSimilarityModel(SimilarityModel model)

Description copied from interface: Retriever

Sets the similarity model. By default, the default model is used.

Specified by:

setSimilarityModel in interface Retriever<TCase extends DataObject,TQuery extends Query>

getValuator

protected SimilarityValuator getValuator()

Returns:

Returns the similarity valuator for performing the retrieval

isAddQueryToResults

public boolean isAddQueryToResults()

Description copied from interface: Retriever

Checks whether the retriever is instructed to add the query to the RetrievalResultList

Specified by:

isAddQueryToResults in interface Retriever<TCase extends DataObject,TQuery extends Query>

Returns:

boolean

setAddQueryToResults

public void setAddQueryToResults(boolean addQueryToResults)

Description copied from interface: Retriever

Instructs retriever to add the query to the RetrievalResultList depending on addQueryToResults

Specified by:

setAddQueryToResults in interface Retriever<TCase extends DataObject,TQuery extends Query>

Parameters:

addQueryToResults - Defines, whether query should be added or not

newQuery

public TQuery 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 Retriever<TCase extends DataObject,TQuery extends Query>

Returns:

a new query object.