Lucene.Net.Search.Payloads.PayloadTermQuery Class Reference

This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the value of the payload located at each of the positions where the Lucene.Net.Index.Term occurs. In order to take advantage of this, you must override Lucene.Net.Search.Similarity.ScorePayload(int, String, int, int, byte[],int,int) which returns 1 by default. Payload scores are aggregated using a pluggable PayloadFunction. More...

Inherits SpanTermQuery.

Classes
class	PayloadTermWeight

Public Member Functions
	PayloadTermQuery (Term term, PayloadFunction function)
	PayloadTermQuery (Term term, PayloadFunction function, bool includeSpanScore)
override Weight	CreateWeight (Searcher searcher)
override int	GetHashCode ()
override bool	Equals (System.Object obj)

Detailed Description

This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the value of the payload located at each of the positions where the Lucene.Net.Index.Term occurs.

In order to take advantage of this, you must override Lucene.Net.Search.Similarity.ScorePayload(int, String, int, int, byte[],int,int) which returns 1 by default.

Payload scores are aggregated using a pluggable PayloadFunction.

Definition at line 50 of file PayloadTermQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Payloads.PayloadTermQuery.PayloadTermQuery	(	Term	term,
		PayloadFunction	function
	)

Definition at line 55 of file PayloadTermQuery.cs.

Lucene.Net.Search.Payloads.PayloadTermQuery.PayloadTermQuery	(	Term	term,
		PayloadFunction	function,
		bool	includeSpanScore
	)

Definition at line 59 of file PayloadTermQuery.cs.

Member Function Documentation

override Weight Lucene.Net.Search.Payloads.PayloadTermQuery.CreateWeight

(

Searcher

searcher

)

Definition at line 65 of file PayloadTermQuery.cs.

override bool Lucene.Net.Search.Payloads.PayloadTermQuery.Equals

(

System.Object

obj

)

Definition at line 234 of file PayloadTermQuery.cs.

override int Lucene.Net.Search.Payloads.PayloadTermQuery.GetHashCode

(

)

Definition at line 225 of file PayloadTermQuery.cs.

---

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

• core/Search/Payloads/PayloadTermQuery.cs