Class NearSpansOrdered

A Spans that is formed from the ordered subspans of a SpanNearQuery where the subspans do not overlap and have a maximum slop between them.

The formed spans only contains minimum slop matches.

The matching slop is computed from the distance(s) between the non overlapping matching Spans.

Successive matches are always formed from the successive Spans of the SpanNearQuery.

The formed spans may contain overlaps when the slop is at least 1. For example, when querying using t1 t2 t3 with slop at least 1, the fragment: t1 t2 t1 t3 t2 t3 matches twice: t1 t2 .. t3 t1 .. t2 t3

Expert: Only public for subclassing. Most implementations should not need this class

Inheritance
System.Object
Spans
NearSpansOrdered
Assembly: DistributedLucene.Net.dll
Syntax
public class NearSpansOrdered : Spans

Constructors

Name Description
NearSpansOrdered(SpanNearQuery, AtomicReaderContext, IBits, IDictionary<Term, TermContext>)
NearSpansOrdered(SpanNearQuery, AtomicReaderContext, IBits, IDictionary<Term, TermContext>, Boolean)

Properties

Name Description
Doc

Returns the document number of the current match. Initially invalid.

End

Returns the end position of the current match. Initially invalid.

IsPayloadAvailable
Start

Returns the start position of the current match. Initially invalid.

SubSpans

Methods

Name Description
GetCost()
GetPayload()
Next()

Move to the next match, returning true iff any such exists.

SkipTo(Int32)

Skips to the first match beyond the current, whose document number is greater than or equal to target.

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.

Returns true if there is such a match.

Behaves as if written: 

    bool SkipTo(int target) 
    {
        do 
        {
            if (!Next())
                return false;
        } while (target > Doc);
        return true;
    }

Most implementations are considerably more efficient than that.
ToString()

Extension Methods