Lucene.Net.Search.Spans.NearSpansUnordered Class Reference

Similar to NearSpansOrdered, but for the unordered case. More...

Inherits Lucene.Net.Search.Spans.Spans.

Public Member Functions
	NearSpansUnordered (SpanNearQuery query, IndexReader reader)
virtual Spans[]	GetSubSpans ()
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 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.
override ICollection< byte[]>	GetPayload ()
	WARNING: The List is not necessarily in order of the the positions
override bool	IsPayloadAvailable ()
	Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to Next().
override System.String	ToString ()

Detailed Description

Similar to NearSpansOrdered, but for the unordered case.

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

Definition at line 32 of file NearSpansUnordered.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.NearSpansUnordered.NearSpansUnordered	(	SpanNearQuery	query,
		IndexReader	reader
	)

Definition at line 177 of file NearSpansUnordered.cs.

Member Function Documentation

override int Lucene.Net.Search.Spans.NearSpansUnordered.Doc ( )

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 304 of file NearSpansUnordered.cs.

override int Lucene.Net.Search.Spans.NearSpansUnordered.End ( )

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 312 of file NearSpansUnordered.cs.

override ICollection<byte[]> Lucene.Net.Search.Spans.NearSpansUnordered.GetPayload ( )

virtual

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

Returns

Collection of <c>byte[]</c> payloads

<throws> IOException </throws>

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 322 of file NearSpansUnordered.cs.

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

virtual

Definition at line 192 of file NearSpansUnordered.cs.

override bool Lucene.Net.Search.Spans.NearSpansUnordered.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 337 of file NearSpansUnordered.cs.

override bool Lucene.Net.Search.Spans.NearSpansUnordered.Next ( )

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 196 of file NearSpansUnordered.cs.

override bool Lucene.Net.Search.Spans.NearSpansUnordered.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 264 of file NearSpansUnordered.cs.

override int Lucene.Net.Search.Spans.NearSpansUnordered.Start ( )

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 308 of file NearSpansUnordered.cs.

override System.String Lucene.Net.Search.Spans.NearSpansUnordered.ToString

(

)

Definition at line 352 of file NearSpansUnordered.cs.

---

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

• core/Search/Spans/NearSpansUnordered.cs