Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Search.Spans.SpanWeight Class Reference

Expert-only. Public for use by other weight implementations More...

Inherits Lucene.Net.Search.Weight.

Public Member Functions

 SpanWeight (SpanQuery query, Searcher searcher)
 
override float GetSumOfSquaredWeights ()
 The sum of squared weights of contained query clauses.
 
override void Normalize (float queryNorm)
 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.
 

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

Expert-only. Public for use by other weight implementations

Definition at line 30 of file SpanWeight.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.SpanWeight.SpanWeight ( SpanQuery  query,
Searcher  searcher 
)

Definition at line 42 of file SpanWeight.cs.

Member Function Documentation

override Explanation Lucene.Net.Search.Spans.SpanWeight.Explain ( IndexReader  reader,
int  doc 
)
virtual

An explanation of the score computation for the named document.

Parameters
readersub-reader containing the give doc
doc
Returns
an Explanation for the score

<throws> IOException </throws>

Implements Lucene.Net.Search.Weight.

Definition at line 82 of file SpanWeight.cs.

override float Lucene.Net.Search.Spans.SpanWeight.GetSumOfSquaredWeights ( )
virtual

The sum of squared weights of contained query clauses.

Implements Lucene.Net.Search.Weight.

Definition at line 64 of file SpanWeight.cs.

override void Lucene.Net.Search.Spans.SpanWeight.Normalize ( float  norm)
virtual

Assigns the query normalization factor to this.

Implements Lucene.Net.Search.Weight.

Definition at line 70 of file SpanWeight.cs.

override Scorer Lucene.Net.Search.Spans.SpanWeight.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
readerthe IndexReader for which to return the Lucene.Net.Search.Scorer.
scoreDocsInOrderspecifies 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.
topScorerif 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 77 of file SpanWeight.cs.

Property Documentation

override Query Lucene.Net.Search.Spans.SpanWeight.Query
get

Definition at line 55 of file SpanWeight.cs.

override float Lucene.Net.Search.Spans.SpanWeight.Value
get

Definition at line 60 of file SpanWeight.cs.


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