Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Public Member Functions | List of all members
Lucene.Net.Search.Spans.NearSpansOrdered Class Reference

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 More...

Inherits Lucene.Net.Search.Spans.Spans.

Classes

class  AnonymousClassComparator
 

Public Member Functions

 NearSpansOrdered (SpanNearQuery spanNearQuery, IndexReader reader)
 
 NearSpansOrdered (SpanNearQuery spanNearQuery, IndexReader reader, bool collectPayloads)
 
override int Doc ()
 Returns the document number of the current match. Initially invalid.
 
override int Start ()
 Returns the start position of the current match. Initially invalid.
 
override int End ()
 Returns the end position of the current match. Initially invalid.
 
virtual Spans[] GetSubSpans ()
 
override 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.

 
override bool IsPayloadAvailable ()
 Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to Next().
 
override bool Next ()
 Move to the next match, returning true iff any such exists.
 
override 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:
 
override System.String ToString ()
 

Detailed Description

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

Definition at line 47 of file NearSpansOrdered.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.NearSpansOrdered.NearSpansOrdered ( SpanNearQuery  spanNearQuery,
IndexReader  reader 
)

Definition at line 98 of file NearSpansOrdered.cs.

Lucene.Net.Search.Spans.NearSpansOrdered.NearSpansOrdered ( SpanNearQuery  spanNearQuery,
IndexReader  reader,
bool  collectPayloads 
)

Definition at line 102 of file NearSpansOrdered.cs.

Member Function Documentation

override int Lucene.Net.Search.Spans.NearSpansOrdered.Doc ( )
virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 124 of file NearSpansOrdered.cs.

override int Lucene.Net.Search.Spans.NearSpansOrdered.End ( )
virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 136 of file NearSpansOrdered.cs.

override ICollection<byte[]> Lucene.Net.Search.Spans.NearSpansOrdered.GetPayload ( )
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>

Returns
a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false

<throws> java.io.IOException </throws>

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 149 of file NearSpansOrdered.cs.

virtual Spans [] Lucene.Net.Search.Spans.NearSpansOrdered.GetSubSpans ( )
virtual

Definition at line 141 of file NearSpansOrdered.cs.

override bool Lucene.Net.Search.Spans.NearSpansOrdered.IsPayloadAvailable ( )
virtual

Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to Next().

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 156 of file NearSpansOrdered.cs.

override bool Lucene.Net.Search.Spans.NearSpansOrdered.Next ( )
virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 162 of file NearSpansOrdered.cs.

override bool Lucene.Net.Search.Spans.NearSpansOrdered.SkipTo ( int  target)
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.

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 185 of file NearSpansOrdered.cs.

override int Lucene.Net.Search.Spans.NearSpansOrdered.Start ( )
virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 130 of file NearSpansOrdered.cs.

override System.String Lucene.Net.Search.Spans.NearSpansOrdered.ToString ( )

Definition at line 431 of file NearSpansOrdered.cs.


The documentation for this class was generated from the following file: