FeatureRetriever (ProCAKE Framework 4.0.0 API)

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<NESTWorkflowObject,Query>
    - - de.uni_trier.wi2.procake.retrieval.impl.macfac.fb.FeatureRetriever

All Implemented Interfaces:: RetrievalFactoryObject, Retriever<NESTWorkflowObject,Query>

public class FeatureRetriever
extends RetrieverImpl<NESTWorkflowObject,Query>
implements Retriever<NESTWorkflowObject,Query>, RetrievalFactoryObject

Field Summary
- Fields inherited from interface de.uni_trier.wi2.procake.retrieval.Retriever
  DEFAULT_ADDQUERYTORESULTS

Constructor Summary

Constructors
Constructor Description

FeatureRetriever()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getRetrieverName()`	Each retriever must have an unique name.
`Query`	`newQuery()`	Creates a new `Query` for the retriever.
`RetrievalResultList`	`perform(Query query)`	Performs a retrieval for the given query.

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
  - FeatureRetriever
```
public FeatureRetriever()
```
- Method Detail
  - 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<NESTWorkflowObject,Query>
    
    Overrides:
    
    newQuery in class RetrieverImpl<NESTWorkflowObject,Query>
    
    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<NESTWorkflowObject,Query>
    
    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.