Package de.uni_trier.wi2.procake.retrieval

Retrieval package description

This package includes several retrieval implementations such as a linear retriever and a multi-threaded version that accelerates the retrieval by using all CPU-cores. In addition, a MAC/FAC retrieval implementation and a A*-parallel retriever exist to speed-up retrieval.

Interface Summary

Interface	Description
DependencyQuery	Interface, that provides a description of a dependency query to be used in Retriever.perform(Query).
DependencyRetrievalResult	Interface for the dependency specific implementation of RetrievalResult, which contains a list of the result objects and the similarity value.
DependencyRetrievalResultList	Interface for the dependency specific implementation of RetrievalResultList.
DependencyRetriever	Interface for the dependency specific retriever, that implements the approach of dependency-guided retrieval.
MACFACQuery	A MACFAC query needs additional parameters compared to a standard retrieval query.
ParallelLinearRetriever<TCase extends DataObject,TQuery extends Query>	Interface for a parallelized LinearRetriever.
Query	Description of a query to be used in Retriever.perform(Query).
RetrievalFactoryObject	The retrieval factory object provides the constructor for the retriever and the name of the retriever.
RetrievalQuality	Interface to calculate the retrieval quality
RetrievalResult	One retrieval result.
RetrievalResultList	A list of retrieval results.
Retriever<TCase extends DataObject,TQuery extends Query>	General retriever interface that describes the minimum methods a retriever must implement.
SystemRetrievers	A list of retriever names provided by ProCAKE

Class Summary

Class	Description
IdSimilarityPair	Wrapper class for a pair of case ID and a similarity value.
RetrievalFactory	This factory creates several retriever instances.
SimpleSimilarityResult	This class is meant to be a lightweight version of the retrieval result with only a query id and a list of cases with their respective similarity.

Enum Summary

Enum	Description
RetrievalQuality.QualityCriterion	enumeration to define quality criterion