Class NearSpansUnordered

Similar to NearSpansOrdered, but for the unordered case.

Expert: Only public for subclassing. Most implementations should not need this class
Inheritance
object
Spans
NearSpansUnordered
Inherited Members
Namespace: Lucene.Net.Search.Spans
Assembly: Lucene.Net.dll
Syntax
public class NearSpansUnordered : Spans

Constructors

NearSpansUnordered(SpanNearQuery, AtomicReaderContext, IBits, IDictionary<Term, TermContext>)

Similar to NearSpansOrdered, but for the unordered case.

Expert: Only public for subclassing. Most implementations should not need this class
Declaration
public NearSpansUnordered(SpanNearQuery query, AtomicReaderContext context, IBits acceptDocs, IDictionary<Term, TermContext> termContexts)
Parameters
Type Name Description
SpanNearQuery query
AtomicReaderContext context
IBits acceptDocs
IDictionary<Term, TermContext> termContexts

Properties

Doc

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

Declaration
public override int Doc { get; }
Property Value
Type Description
int
Overrides

End

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

Declaration
public override int End { get; }
Property Value
Type Description
int
Overrides

IsPayloadAvailable

Checks if a payload can be loaded at this position.

Payloads can only be loaded once per call to MoveNext().
Declaration
public override bool IsPayloadAvailable { get; }
Property Value
Type Description
bool

true if there is a payload available at this position that can be loaded
Overrides

Start

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

Declaration
public override int Start { get; }
Property Value
Type Description
int
Overrides

SubSpans

Similar to NearSpansOrdered, but for the unordered case.

Expert: Only public for subclassing. Most implementations should not need this class
Declaration
public virtual Spans[] SubSpans { get; }
Property Value
Type Description
Spans[]

Methods

GetCost()

Returns the estimated cost of this spans.

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

GetPayload()

WARNING: The List is not necessarily in order of the the positions

Declaration
public override ICollection<byte[]> GetPayload()
Returns
Type Description
ICollection<byte[]>

Collection of byte[] payloads
Overrides
Exceptions
Type Condition
IOException

if there is a low-level I/O error

MoveNext()

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

Declaration
public override bool MoveNext()
Returns
Type Description
bool
Overrides

SkipTo(int)

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.
Declaration
public override bool SkipTo(int target)
Parameters
Type Name Description
int target
Returns
Type Description
bool
Overrides

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