Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
Expert: an enumeration of span matches. Used to implement span searching. Each span represents a range of term positions within a document. Matches are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position. More...
Inherited by Lucene.Net.Search.Spans.NearSpansOrdered, Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansUnordered.SpansCell, Lucene.Net.Search.Spans.SpanFirstQuery.AnonymousClassSpans, Lucene.Net.Search.Spans.SpanNotQuery.AnonymousClassSpans, Lucene.Net.Search.Spans.SpanOrQuery.AnonymousClassSpans, and Lucene.Net.Search.Spans.TermSpans.
Public Member Functions | |
abstract bool | Next () |
Move to the next match, returning true iff any such exists. | |
abstract bool | SkipTo (int target) |
Skips to the first match beyond the current, whose document number is greater than or equal to target. Returns true iff there is such a match. Behaves as if written: | |
abstract int | Doc () |
Returns the document number of the current match. Initially invalid. | |
abstract int | Start () |
Returns the start position of the current match. Initially invalid. | |
abstract int | End () |
Returns the end position of the current match. Initially invalid. | |
abstract ICollection< byte[]> | GetPayload () |
Returns the payload data for the current span. This is invalid until Next() is called for the first time. This method must not be called more than once after each call of Next(). However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option. | |
abstract bool | IsPayloadAvailable () |
Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to Next(). | |
Expert: an enumeration of span matches. Used to implement span searching. Each span represents a range of term positions within a document. Matches are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position.
|
pure virtual |
Returns the document number of the current match. Initially invalid.
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.
|
pure virtual |
Returns the end position of the current match. Initially invalid.
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.
|
pure virtual |
Returns the payload data for the current span. This is invalid until Next() is called for the first time. This method must not be called more than once after each call of Next(). However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.
Note that the return type is a collection, thus the ordering should not be relied upon.
<font color="#FF0000"> WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.</font>
<throws> java.io.IOException </throws>
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.
|
pure virtual |
Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to Next().
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.
|
pure virtual |
Move to the next match, returning true iff any such exists.
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.
|
pure virtual |
Skips to the first match beyond the current, whose document number is greater than or equal to target. Returns true iff there is such a match. Behaves as if written:
boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; }
Most implementations are considerably more efficient than that.
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.
|
pure virtual |
Returns the start position of the current match. Initially invalid.
Implemented in Lucene.Net.Search.Spans.NearSpansUnordered, Lucene.Net.Search.Spans.NearSpansOrdered, and Lucene.Net.Search.Spans.TermSpans.