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

Class AbstractMACFACRetriever<TCase extends DataObject>

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,MACFACQuery>

de.uni_trier.wi2.procake.retrieval.impl.macfac.AbstractMACFACRetriever<TCase>

All Implemented Interfaces:

Retriever<TCase,MACFACQuery>

Direct Known Subclasses:

FeatureMACFACRetriever

public abstract class AbstractMACFACRetriever<TCase extends DataObject>
extends RetrieverImpl<TCase,MACFACQuery>
implements Retriever<TCase,MACFACQuery>

Generic super class for MAC/FAC retrievers. The class takes two specific retriever instances, i.e., the MAC retriever and the FAC retriever. This class is intended to be used as a super class for MAC/FAC retrievers. Thereby, it is important that the inheriting classes implement RetrievalFactoryObject in order to be instantiated properly during ProCAKE start.

Author:

Maximilian Hoffmann

See Also:

FeatureMACFACRetriever

Field Summary

Fields

Modifier and Type	Field	Description
protected Retriever<TCase,Query>	facRetriever
protected Retriever<TCase,Query>	macRetriever

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

DEFAULT_ADDQUERYTORESULTS

Constructor Summary

Constructors

Constructor	Description
AbstractMACFACRetriever()

Method Summary

Modifier and Type	Method	Description
Retriever<TCase,Query>	getFACRetriever()	Returns the FAC retriever instance of the MAC/FAC setup.
Retriever<TCase,Query>	getMACRetriever()	Returns the MAC retriever instance of the MAC/FAC setup.
MACFACQuery	newQuery()	Creates a new Query for the retriever.
RetrievalResultList	perform(MACFACQuery query)	Performs a retrieval for the given query.
void	setFACRetriever(Retriever<TCase,Query> facRetriever)	Set the FAC retriever instance that is used to execute the FAC phase of the MAC/FAC retrieval.
void	setMACRetriever(Retriever<TCase,Query> macRetriever)	Set the MAC retriever instance that is used to execute the MAC phase of the MAC/FAC retrieval.

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

Field Detail

macRetriever

protected Retriever<TCase extends DataObject,Query> macRetriever

facRetriever

protected Retriever<TCase extends DataObject,Query> facRetriever

Constructor Detail

AbstractMACFACRetriever

public AbstractMACFACRetriever()

Method Detail

getMACRetriever

public Retriever<TCase,Query> getMACRetriever()

Returns the MAC retriever instance of the MAC/FAC setup.

Returns:

the MAC retriever instance

setMACRetriever

public void setMACRetriever(Retriever<TCase,Query> macRetriever)

Set the MAC retriever instance that is used to execute the MAC phase of the MAC/FAC retrieval.

Parameters:

macRetriever - a retriever instance that is ready to use in the MAC/FAC setup

getFACRetriever

public Retriever<TCase,Query> getFACRetriever()

Returns the FAC retriever instance of the MAC/FAC setup.

Returns:

the FAC retriever instance

setFACRetriever

public void setFACRetriever(Retriever<TCase,Query> facRetriever)

Set the FAC retriever instance that is used to execute the FAC phase of the MAC/FAC retrieval.

Parameters:

facRetriever - a retriever instance that is ready to use in the MAC/FAC setup

perform

public RetrievalResultList perform(MACFACQuery query)

Description copied from interface: Retriever

Performs a retrieval for the given query.

Specified by:

perform in interface Retriever<TCase extends DataObject,MACFACQuery>

Parameters:

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

Returns:

a list of retrieval results

newQuery

public MACFACQuery 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,MACFACQuery>

Overrides:

newQuery in class RetrieverImpl<TCase extends DataObject,MACFACQuery>

Returns:

a new query object.