Lucene.Net.Search.Spans.TermSpans Class Reference

Expert: Public for extension only More...

Inherits Lucene.Net.Search.Spans.Spans.

Public Member Functions
	TermSpans (TermPositions positions, Term term)
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 ()
	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 System.String	ToString ()

Properties
virtual TermPositions	Positions [get]

Detailed Description

Expert: Public for extension only

Definition at line 29 of file TermSpans.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.TermSpans.TermSpans	(	TermPositions	positions,
		Term	term
	)

Definition at line 39 of file TermSpans.cs.

Member Function Documentation

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

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 83 of file TermSpans.cs.

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

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 93 of file TermSpans.cs.

override ICollection<byte[]> Lucene.Net.Search.Spans.TermSpans.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 100 of file TermSpans.cs.

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

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

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 47 of file TermSpans.cs.

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

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

virtual

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

Implements Lucene.Net.Search.Spans.Spans.

Definition at line 88 of file TermSpans.cs.

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

(

)

Definition at line 116 of file TermSpans.cs.

Property Documentation

virtual TermPositions Lucene.Net.Search.Spans.TermSpans.Positions

get

Definition at line 122 of file TermSpans.cs.

---

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

• core/Search/Spans/TermSpans.cs