org.terrier.matching
Interface Matching

All Known Implementing Classes:

BaseMatching, Full, Full, FullNoPLM, FullNoPLM, OldBasicMatching, TRECResultsMatching

public interface Matching

Interface for all Matching implementations.

Since:

3.0

Author:

Vassilis Plachouras, Craig Macdonald

Method Summary

java.lang.String	getInfo() Return a human readable description of this Matching class
ResultSet	match(java.lang.String queryNumber, MatchingQueryTerms queryTerms) Get a ResultSet for the given query terms.
void	setCollectionStatistics(CollectionStatistics cs) Update the collection statistics being used by this matching instance

Method Detail

getInfo

java.lang.String getInfo()

Return a human readable description of this Matching class

match

ResultSet match(java.lang.String queryNumber,
                MatchingQueryTerms queryTerms)
                throws java.io.IOException

Get a ResultSet for the given query terms.

Parameters:

queryNumber - - some ID of the query

queryTerms - - query terms to match

Returns:

ResultSet - the matched results

Throws:

java.io.IOException - if a problem occurs during matching

setCollectionStatistics

void setCollectionStatistics(CollectionStatistics cs)

Update the collection statistics being used by this matching instance

Parameters:

cs - CollectionStatistics to use during matching