org.apache.lucene.search.highlight
Interface Scorer

All Known Implementing Classes:

QueryScorer, SpanScorer

public interface Scorer

Adds to the score for a fragment based on its tokens

Method Summary

float	getFragmentScore() Called when the highlighter has no more tokens for the current fragment - the scorer returns the weighting it has derived for the most recent fragment, typically based on the tokens passed to getTokenScore().
float	getTokenScore(Token token) Called for each token in the current fragment
void	startFragment(TextFragment newFragment) called when a new fragment is started for consideration

Method Detail

startFragment

void startFragment(TextFragment newFragment)

called when a new fragment is started for consideration

Parameters:

newFragment -

getTokenScore

float getTokenScore(Token token)

Called for each token in the current fragment

Parameters:

token - The token to be scored

Returns:

a score which is passed to the Highlighter class to influence the mark-up of the text (this return value is NOT used to score the fragment)

getFragmentScore

float getFragmentScore()

Called when the highlighter has no more tokens for the current fragment - the scorer returns the weighting it has derived for the most recent fragment, typically based on the tokens passed to getTokenScore().