dragon.ir.search

Interface Searcher

All Known Implementing Classes:

AbstractSearcher, BoolRankSearcher, FeedbackSearcher, FullRankSearcher, PartialRankSearcher, QueryExpansionSearcher

public interface Searcher

Interface of Text Searcher

The toolkit provides a well-defined framework for text retrieval. The first step is to generate a query according to the topic descriptions (such as TREC Topic files). Please refer to the package of dragon.ir.query for query generation. The second step is to create a searcher. Since there are so many different retrieval models, the toolkit creates an interface called Smoother to hide the implementation details of different models. Thus, the routine for searching is the same for different models. One can simply call a full rank searcher or a partial rank searcher.

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

Modifier and Type	Method and Description
IndexReader	getIndexReader()
IRDoc	getIRDoc(int ranking) Before calling this method, one should call the search function.
IRQuery	getQuery()
boolean	getQueryWeightingOption()
ArrayList	getRankedDocumentList()
int	getRetrievedDocNum()
Smoother	getSmoother()
int	search(IRQuery query)
void	setQueryWeightingOption(boolean option) If the weighting option is set to false, the searcher ignores the weight of searching terms.

Method Detail

search

int search(IRQuery query)

Parameters:

query - the structured query

Returns:

the number of matched documents

getIRDoc

IRDoc getIRDoc(int ranking)

Before calling this method, one should call the search function.

Parameters:

ranking - the position of the ranked documents. The position starts from zero.

Returns:

the retrieved document in the given position

getRankedDocumentList

ArrayList getRankedDocumentList()

Returns:

all retrieved document in ranked order

getRetrievedDocNum

int getRetrievedDocNum()

Returns:

the number of retrieved documents

getIndexReader

IndexReader getIndexReader()

Returns:

the index reader the current searcher is working on

getSmoother

Smoother getSmoother()

Returns:

the smoother used for this searcher.

getQuery

IRQuery getQuery()

setQueryWeightingOption

void setQueryWeightingOption(boolean option)

If the weighting option is set to false, the searcher ignores the weight of searching terms.

Parameters:

option - the weighting option

getQueryWeightingOption

boolean getQueryWeightingOption()