Class TermSpans

Expert: Public for extension only

Inheritance
object
Spans
TermSpans
Inherited Members
Namespace: Lucene.Net.Search.Spans
Assembly: Lucene.Net.dll
Syntax
public class TermSpans : Spans

Constructors

TermSpans(DocsAndPositionsEnum, Term)

Expert: Public for extension only

Declaration
public TermSpans(DocsAndPositionsEnum postings, Term term)
Parameters
Type Name Description
DocsAndPositionsEnum postings
Term term

Fields

EMPTY_TERM_SPANS

Expert: Public for extension only

Declaration
public static readonly TermSpans EMPTY_TERM_SPANS
Field Value
Type Description
TermSpans

m_count

Expert: Public for extension only

Declaration
protected int m_count
Field Value
Type Description
int

m_doc

Expert: Public for extension only

Declaration
protected int m_doc
Field Value
Type Description
int

m_freq

Expert: Public for extension only

Declaration
protected int m_freq
Field Value
Type Description
int

m_position

Expert: Public for extension only

Declaration
protected int m_position
Field Value
Type Description
int

m_postings

Expert: Public for extension only

Declaration
protected readonly DocsAndPositionsEnum m_postings
Field Value
Type Description
DocsAndPositionsEnum

m_readPayload

Expert: Public for extension only

Declaration
protected bool m_readPayload
Field Value
Type Description
bool

m_term

Expert: Public for extension only

Declaration
protected readonly Term m_term
Field Value
Type Description
Term

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

Postings

Expert: Public for extension only

Declaration
public virtual DocsAndPositionsEnum Postings { get; }
Property Value
Type Description
DocsAndPositionsEnum

Start

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

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

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()

Returns the payload data for the current span. this is invalid until MoveNext() is called for the first time. This method must not be called more than once after each call of MoveNext(). 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.

Note

This API is experimental and might change in incompatible ways in the next release.

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

A ICollection{byte[]} of byte arrays containing the data of this payload, otherwise null if IsPayloadAvailable is false
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