org.terrier.matching

Interface Matching

All Known Implementing Classes:

BaseMatching, FatFeaturedScoringMatching, FatFull, FatResultsMatching, FatScoringMatching, Full, Full, FullNoPLM, FullNoPLM, JforestsModelMatching, LearnedModelMatching, LinearModelMatching, TRECResultsMatching

public interface Matching

Interface for all Matching implementations.

Since:

3.0

Author:

Vassilis Plachouras, Craig Macdonald

Method Summary

Methods

Modifier and Type	Method and Description
String	getInfo() Return a human readable description of this Matching class
ResultSet	match(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

String getInfo()

Return a human readable description of this Matching class

match

ResultSet match(String queryNumber,
              MatchingQueryTerms queryTerms)
                throws 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:

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