org.terrier.matching.dsms

Interface DocumentScoreModifier

All Superinterfaces:

Cloneable

All Known Implementing Classes:

BooleanFallback, BooleanScoreModifier, DependenceScoreModifier, DFRDependenceScoreModifier, MRFDependenceScoreModifier, PhraseScoreModifier, ResetScores, SimpleStaticScoreModifier

public interface DocumentScoreModifier
extends Cloneable

The interface that should be implemented by each class that assigns or modifies a score of a document.

Author:

Vassilis Plachouras, Craig Macdonald

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates the close of this object
String	getName() Returns the name of the document score modifier.
boolean	modifyScores(Index index, MatchingQueryTerms queryTerms, ResultSet resultSet) Modifies the scores of the documents for a given query.

Method Detail

modifyScores

boolean modifyScores(Index index,
                     MatchingQueryTerms queryTerms,
                     ResultSet resultSet)

Modifies the scores of the documents for a given query. This returns a boolean that allows the Matching class to determine if the scores of the documents have actually been altered. This is because the resultset has to be resorted after each one.

Parameters:

index - Index the data structures used for retrieval.

queryTerms - MatchingQueryTerms[] the query terms

resultSet - ResultSet the current set of results.

Returns:

true if any scores have been altered

getName

String getName()

Returns the name of the document score modifier.

Returns:

String the name of the document score modifier.

clone

Object clone()

Creates the close of this object