Class ValueSourceScorer

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Inheritance

object

DocIdSetIterator

DocsEnum

Scorer

ValueSourceScorer

Inherited Members

Scorer.m_weight

Scorer.Weight

Scorer.GetChildren()

DocsEnum.Attributes

DocIdSetIterator.GetEmpty()

DocIdSetIterator.NO_MORE_DOCS

DocIdSetIterator.SlowAdvance(int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Queries.Function

Assembly: Lucene.Net.Queries.dll

Syntax

public class ValueSourceScorer : Scorer

Constructors

ValueSourceScorer(IndexReader, FunctionValues)

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

protected ValueSourceScorer(IndexReader reader, FunctionValues values)

Parameters

Type	Name	Description
IndexReader	reader
FunctionValues	values

Fields

m_checkDeletes

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

protected bool m_checkDeletes

Field Value

Type	Description
bool

m_maxDoc

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

protected readonly int m_maxDoc

Field Value

Type	Description
int

m_reader

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

protected readonly IndexReader m_reader

Field Value

Type	Description
IndexReader

m_values

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

protected readonly FunctionValues m_values

Field Value

Type	Description
FunctionValues

Properties

DocID

Returns the following:

• -1 or Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if Lucene.Net.Search.DocIdSetIterator.NextDoc() or Advance(int) were not called yet.
• Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
• Otherwise it should return the doc ID it is currently on.

@since 2.9

Declaration

public override int DocID { get; }

Property Value

Type	Description
int

Overrides

Lucene.Net.Search.DocIdSetIterator.DocID

Freq

Returns term frequency in the current document, or 1 if the field was indexed with Lucene.Net.Index.IndexOptions.DOCS_ONLY. Do not call this before Lucene.Net.Search.DocIdSetIterator.NextDoc() is first called, nor after Lucene.Net.Search.DocIdSetIterator.NextDoc() returns Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS.

NOTE: if the Lucene.Net.Index.DocsEnum was obtain with Lucene.Net.Index.DocsFlags.NONE, the result of this method is undefined.

Declaration

public override int Freq { get; }

Property Value

Type	Description
int

Overrides

Lucene.Net.Index.DocsEnum.Freq

Reader

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

public virtual IndexReader Reader { get; }

Property Value

Type	Description
IndexReader

Methods

Advance(int)

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target <= current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it behaves as if written:

int Advance(int target) 
{
    int doc;
    while ((doc = NextDoc()) < target) 
    {
    }
    return doc;
}

Some implementations are considerably more efficient than that.

NOTE: this method may be called with Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS for efficiency by some Lucene.Net.Search.Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

@since 2.9

Declaration

public override int Advance(int target)

Parameters

Type	Name	Description
int	target

Returns

Type	Description
int

Overrides

DocIdSetIterator.Advance(int)

GetCost()

Returns the estimated cost of this Lucene.Net.Search.DocIdSetIterator.

This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

Declaration

public override long GetCost()

Returns

Type	Description
long

Overrides

Lucene.Net.Search.DocIdSetIterator.GetCost()

GetScore()

Returns the score of the current document matching the query. Initially invalid, until Lucene.Net.Search.DocIdSetIterator.NextDoc() or Advance(int) is called the first time, or when called from within Collect(int).

Declaration

public override float GetScore()

Returns

Type	Description
float

Overrides

Lucene.Net.Search.Scorer.GetScore()

Matches(int)

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

public virtual bool Matches(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
bool

MatchesValue(int)

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

public virtual bool MatchesValue(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
bool

NextDoc()

Advances to the next document in the set and returns the doc it is currently on, or Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

@since 2.9

Declaration

public override int NextDoc()

Returns

Type	Description
int

Overrides

Lucene.Net.Search.DocIdSetIterator.NextDoc()

SetCheckDeletes(bool)

Lucene.Net.Search.Scorer which returns the result of SingleVal(int) as the score for a document.

When overriding this class, be aware that ValueSourceScorer constructor is calling its private SetCheckDeletesInternal method as opposed to virtual SetCheckDeletes method. This is done to avoid virtual call in constructor. You can call your own private method for CheckDeletes initialization in your constructor if you need to.

Declaration

public virtual void SetCheckDeletes(bool checkDeletes)

Parameters

Type	Name	Description
bool	checkDeletes