org.terrier.matching

Class FatFeaturedScoringMatching

java.lang.Object

org.terrier.matching.FatFeaturedScoringMatching

All Implemented Interfaces:

Matching

public class FatFeaturedScoringMatching
extends Object
implements Matching

Makes a FeaturedResultSet by applying a list of features. The input from a parent matching class is a FatResultSet.

Feature names have a particular format:

• WMODEL: defines a weighting model for each matching query term, i.e. a query dependent feature.
• QI: defined a weighting model called once for each matching document, i.e. a query independent feature.
• DSM: applies a document score modifier.
.
• SAMPLE the scoring method used by the parent Matching class becomes a feature.

Properties:

• fat.featured.scoring.matching.features - a comma delimited list of features OR the word FILE to load the feature list from a file.
• fat.featured.scoring.matching.features.file - a filename containing a newline delimited list of feature.

Since:

4.0

Author:

Craig Macdonald

See Also:

"About Learning Models with Multiple Query Dependent Features. Craig Macdonald, Rodrygo L.T. Santos, Iadh Ounis and Ben He. Transactions on Information Systems. 31(3). 2013. [PDF]"

Constructor Summary

Constructors

Constructor and Description
FatFeaturedScoringMatching(Index _index, Matching _parent)
FatFeaturedScoringMatching(Index _index, Matching _parent, String[] _featureNames)

Method Summary

Methods

Modifier and Type	Method and Description
ResultSet	doMatch(String queryNumber, MatchingQueryTerms queryTerms, FatResultSet fat)
String	getInfo() Return a human readable description of this Matching class
protected void	loadFeatures(String[] featureNames)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FatFeaturedScoringMatching

public FatFeaturedScoringMatching(Index _index,
                          Matching _parent,
                          String[] _featureNames)
                           throws Exception

Throws:

Exception

FatFeaturedScoringMatching

public FatFeaturedScoringMatching(Index _index,
                          Matching _parent)
                           throws Exception

Throws:

Exception

Method Detail

loadFeatures

protected void loadFeatures(String[] featureNames)
                     throws Exception

Throws:

Exception

getInfo

public String getInfo()

Description copied from interface: Matching

Return a human readable description of this Matching class

Specified by:

getInfo in interface Matching

doMatch

public ResultSet doMatch(String queryNumber,
                MatchingQueryTerms queryTerms,
                FatResultSet fat)
                  throws IOException

Throws:

IOException

match

public ResultSet match(String queryNumber,
              MatchingQueryTerms queryTerms)
                throws IOException

Description copied from interface: Matching

Get a ResultSet for the given query terms.

Specified by:

match in interface Matching

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

public void setCollectionStatistics(CollectionStatistics cs)

Description copied from interface: Matching

Update the collection statistics being used by this matching instance

Specified by:

setCollectionStatistics in interface Matching

Parameters:

cs - CollectionStatistics to use during matching