Lucene.Net.Search.Highlight.QueryTermScorer Class Reference

Inherits Lucene.Net.Search.Highlight.IScorer.

Public Member Functions
	QueryTermScorer (Query query)
	QueryTermScorer (Query query, String fieldName)
	QueryTermScorer (Query query, IndexReader reader, String fieldName)
	QueryTermScorer (WeightedTerm[] weightedTerms)
TokenStream	Init (TokenStream tokenStream)
	Called to init the Scorer with a TokenStream. You can grab references to the attributes you are interested in here and access them from getTokenScore().
void	StartFragment (TextFragment newFragment)
	Called when a new fragment is started for consideration.
float	GetTokenScore ()
	Called for each token in the current fragment. The Highlighter will increment the TokenStream passed to init on every call.
void	AllFragmentsProcessed ()

Properties
float	FragmentScore [get]
float	MaxTermWeight [get]
Properties inherited from Lucene.Net.Search.Highlight.IScorer
float	FragmentScore [get]

Detailed Description

Definition at line 40 of file QueryTermScorer.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer

(

Query

query

)

Definition at line 57 of file QueryTermScorer.cs.

Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer	(	Query	query,
		String	fieldName
	)

Definition at line 69 of file QueryTermScorer.cs.

Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer	(	Query	query,
		IndexReader	reader,
		String	fieldName
	)

Definition at line 85 of file QueryTermScorer.cs.

Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer

(

WeightedTerm[]

weightedTerms

)

Definition at line 90 of file QueryTermScorer.cs.

Member Function Documentation

void Lucene.Net.Search.Highlight.QueryTermScorer.AllFragmentsProcessed

(

)

Definition at line 174 of file QueryTermScorer.cs.

float Lucene.Net.Search.Highlight.QueryTermScorer.GetTokenScore

(

)

Called for each token in the current fragment. The Highlighter will increment the TokenStream passed to init on every call.

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)

summary> 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 results of getTokenScore().

Implements Lucene.Net.Search.Highlight.IScorer.

Definition at line 138 of file QueryTermScorer.cs.

TokenStream Lucene.Net.Search.Highlight.QueryTermScorer.Init

(

TokenStream

tokenStream

)

Called to init the Scorer with a TokenStream. You can grab references to the attributes you are interested in here and access them from getTokenScore().

Parameters

tokenStream

the TokenStream that will be scored.

Returns

either a TokenStream that the Highlighter should continue using (eg if you read the tokenSream in this method) or null to continue using the same TokenStream that was passed in.

Exceptions

IOException

Implements Lucene.Net.Search.Highlight.IScorer.

Definition at line 111 of file QueryTermScorer.cs.

void Lucene.Net.Search.Highlight.QueryTermScorer.StartFragment

(

TextFragment

newFragment

)

Called when a new fragment is started for consideration.

Parameters

newFragment

the fragment that will be scored next

Implements Lucene.Net.Search.Highlight.IScorer.

Definition at line 125 of file QueryTermScorer.cs.

Property Documentation

float Lucene.Net.Search.Highlight.QueryTermScorer.FragmentScore

get

Definition at line 163 of file QueryTermScorer.cs.

float Lucene.Net.Search.Highlight.QueryTermScorer.MaxTermWeight

get

Definition at line 186 of file QueryTermScorer.cs.

---

The documentation for this class was generated from the following file:

• contrib/Highlighter/QueryTermScorer.cs