Class AssertingScorer

Wraps a Lucene.Net.Search.Scorer with additional checks.

Inheritance

object

DocIdSetIterator

DocsEnum

Scorer

AssertingScorer

Inherited Members

Scorer.m_weight

Scorer.Weight

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)

Namespace: Lucene.Net.Search

Assembly: Lucene.Net.TestFramework.dll

Syntax

public class AssertingScorer : Scorer

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

In

Wraps a Lucene.Net.Search.Scorer with additional checks.

Declaration

public virtual Scorer In { get; }

Property Value

Type	Description
Scorer

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)

GetChildren()

Returns child sub-scorers

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public override ICollection<Scorer.ChildScorer> GetChildren()

Returns

Type	Description
ICollection<Scorer.ChildScorer>

Overrides

Lucene.Net.Search.Scorer.GetChildren()

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()

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()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

Wrap(Random, Scorer)

Wraps a Lucene.Net.Search.Scorer with additional checks.

Declaration

public static Scorer Wrap(Random random, Scorer other)

Parameters

Type	Name	Description
Random	random
Scorer	other

Returns

Type	Description
Scorer