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

Class LinearRetrieverImpl

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

de.uni_trier.wi2.procake.retrieval.impl.LinearRetrieverImpl

All Implemented Interfaces:

RetrievalFactoryObject, Retriever

public class LinearRetrieverImpl
extends RetrieverImpl
implements Retriever, RetrievalFactoryObject

Author:

rmaximi

Field Summary

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

DEFAULT_ADDQUERYTORESULTS

Constructor Summary

Constructors

Constructor	Description
LinearRetrieverImpl()

Method Summary

Modifier and Type	Method	Description
String	getRetrieverName()	Each retriever must have an unique name.
SimilarityCache	getSimilarityCache()
Query	newQuery()	Creates a new Query for the retriever.
RetrievalResultList	perform(Query query)	Performs a retrieval for the given query.
void	setSimilarityCache(SimilarityCache similarityCache)	Sets the similarity cache.

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

getInternalSimilarityMeasure, getObjectPool, getSimilarityModel, getValuator, isAddQueryToResults, setAddQueryToResults, setInternalSimilarityMeasure, setObjectPool, 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, setSimilarityModel

Constructor Detail

LinearRetrieverImpl

public LinearRetrieverImpl()

Method Detail

getSimilarityCache

public SimilarityCache getSimilarityCache()

Overrides:

getSimilarityCache in class RetrieverImpl

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

Overrides:

setSimilarityCache in class RetrieverImpl

newQuery

public Query 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

Overrides:

newQuery in class RetrieverImpl

Returns:

a new query object.

perform

public RetrievalResultList perform(Query query)

Description copied from interface: Retriever

Performs a retrieval for the given query.

Specified by:

perform in interface Retriever

Parameters:

query - A query that can be created with Retriever.newQuery()

Returns:

a list of retrieval results

getRetrieverName

public String getRetrieverName()

Description copied from interface: RetrievalFactoryObject

Each retriever must have an unique name. This name gan be used to get a new retriever instance from the factory.

Specified by:

getRetrieverName in interface RetrievalFactoryObject

Returns:

Returns the name of the retriever.