Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight Class Reference

Inherits Lucene.Net.Search.Weight.

Public Member Functions
	FunctionWeight (Searcher searcher, FunctionQuery q)
override float	GetSumOfSquaredWeights ()
	The sum of squared weights of contained query clauses.
override void	Normalize (float norm)
	Assigns the query normalization factor to this.
override Scorer	Scorer (IndexReader reader, bool scoreDocsInOrder, bool topScorer)
	Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder. NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call GetScoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order. NOTE: null can be returned if no documents will be scored by this query.
override Explanation	Explain (IndexReader reader, int doc)
	An explanation of the score computation for the named document.
Public Member Functions inherited from Lucene.Net.Search.Weight
virtual bool	GetScoresDocsOutOfOrder ()
	Returns true iff this implementation scores docs only out of order. This method is used in conjunction with Collector's AcceptsDocsOutOfOrder and Scorer(Lucene.Net.Index.IndexReader, bool, bool) to create a matching Scorer instance for a given Collector, or vice versa. NOTE: the default implementation returns false, i.e. the Scorer scores documents in-order.

Protected Attributes
Searcher	searcher
float	queryNorm
float	queryWeight
readonly FunctionQuery	enclosingInstance

Properties
override Query	Query [get]
override float	Value [get]
Properties inherited from Lucene.Net.Search.Weight
abstract Query	Query [get]
	The query that this concerns.
abstract float	Value [get]
	The weight for this query.

Detailed Description

Definition at line 62 of file FunctionQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.FunctionWeight	(	Searcher	searcher,
		FunctionQuery	q
	)

Definition at line 69 of file FunctionQuery.cs.

Member Function Documentation

override Explanation Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.Explain ( IndexReader  reader, int  doc  )

virtual

An explanation of the score computation for the named document.

Parameters

reader	sub-reader containing the give doc
doc

Returns

an Explanation for the score

<throws> IOException </throws>

Implements Lucene.Net.Search.Weight.

Definition at line 108 of file FunctionQuery.cs.

override float Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.GetSumOfSquaredWeights ( )

virtual

The sum of squared weights of contained query clauses.

Implements Lucene.Net.Search.Weight.

Definition at line 91 of file FunctionQuery.cs.

override void Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.Normalize ( float  norm )

virtual

Assigns the query normalization factor to this.

Implements Lucene.Net.Search.Weight.

Definition at line 97 of file FunctionQuery.cs.

override Scorer Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.Scorer ( IndexReader  reader, bool  scoreDocsInOrder, bool  topScorer  )

virtual

Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder. NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call GetScoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.

Parameters

reader	the IndexReader for which to return the Lucene.Net.Search.Scorer.
scoreDocsInOrder	specifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not support DocIdSetIterator.NextDoc and/or DocIdSetIterator.Advance(int), therefore it is recommended to request an in-order scorer if use of these methods is required.
topScorer	if true, Lucene.Net.Search.Scorer.Score(Lucene.Net.Search.Collector) will be called; if false, DocIdSetIterator.NextDoc and/or DocIdSetIterator.Advance(int) will be called.

Returns

a Scorer which scores documents in/out-of order.

<throws> IOException </throws>

Implements Lucene.Net.Search.Weight.

Definition at line 103 of file FunctionQuery.cs.

Member Data Documentation

readonly FunctionQuery Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.enclosingInstance

protected

Definition at line 67 of file FunctionQuery.cs.

float Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.queryNorm

protected

Definition at line 65 of file FunctionQuery.cs.

float Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.queryWeight

protected

Definition at line 66 of file FunctionQuery.cs.

Searcher Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.searcher

protected

Definition at line 64 of file FunctionQuery.cs.

Property Documentation

override Query Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.Query

get

Definition at line 82 of file FunctionQuery.cs.

override float Lucene.Net.Spatial.Util.FunctionQuery.FunctionWeight.Value

get

Definition at line 87 of file FunctionQuery.cs.

---

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

• contrib/Spatial/Util/FunctionQuery.cs