Class Passage

Represents a passage (typically a sentence of the document).

A passage contains NumMatches highlights from the query, and the offsets and query terms that correspond with each match.

Note

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

Inheritance

object

Passage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search.PostingsHighlight

Assembly: Lucene.Net.ICU.dll

Syntax

public sealed class Passage

Properties

EndOffset

Gets the end index (exclusive) of the passage in the original content: always >= StartOffset

Declaration

public int EndOffset { get; }

Property Value

Type	Description
int

MatchEnds

End offsets of the term matches, corresponding with MatchStarts.

Only NumMatches are valid. Note that its possible that an end offset could exceed beyond the bounds of the passage EndOffset, if the Lucene.Net.Analysis.Analyzer produced a term which spans a passage boundary.

Declaration

public IReadOnlyList<int> MatchEnds { get; }

Property Value

Type	Description
IReadOnlyList<int>

MatchStarts

Start offsets of the term matches, in increasing order.

Only NumMatches are valid. Note that these offsets are absolute (not relative to StartOffset).

Declaration

public IReadOnlyList<int> MatchStarts { get; }

Property Value

Type	Description
IReadOnlyList<int>

MatchTerms

BytesRef (term text) of the matches, corresponding with MatchStarts.

Only NumMatches are valid.

Declaration

public IReadOnlyList<BytesRef> MatchTerms { get; }

Property Value

Type	Description
IReadOnlyList<BytesRef>

NumMatches

Number of term matches available in MatchStarts, MatchEnds, MatchTerms

Declaration

public int NumMatches { get; }

Property Value

Type	Description
int

Score

Passage's score.

Declaration

public float Score { get; }

Property Value

Type	Description
float

StartOffset

Gets the start index (inclusive) of the passage in the original content: always >= 0.

Declaration

public int StartOffset { get; }

Property Value

Type	Description
int