Class TokenGroup

One, or several overlapping tokens, along with the score(s) and the scope of the original text

Inheritance

object

TokenGroup

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search.Highlight

Assembly: Lucene.Net.Highlighter.dll

Syntax

public class TokenGroup

Constructors

TokenGroup(TokenStream)

One, or several overlapping tokens, along with the score(s) and the scope of the original text

Declaration

public TokenGroup(TokenStream tokenStream)

Parameters

Type	Name	Description
TokenStream	tokenStream

Properties

EndOffset

the end position in the original text

Declaration

public virtual int EndOffset { get; }

Property Value

Type	Description
int

NumTokens

the number of tokens in this group

Declaration

public virtual int NumTokens { get; }

Property Value

Type	Description
int

StartOffset

the start position in the original text

Declaration

public virtual int StartOffset { get; }

Property Value

Type	Description
int

TotalScore

all tokens' scores summed up

Declaration

public virtual float TotalScore { get; }

Property Value

Type	Description
float

Methods

GetScore(int)

the "n"th score

Declaration

public virtual float GetScore(int index)

Parameters

Type	Name	Description
int	index	a value between 0 and numTokens -1

Returns

Type	Description
float

GetToken(int)

the "n"th token

Declaration

public virtual Token GetToken(int index)

Parameters

Type	Name	Description
int	index	a value between 0 and numTokens -1

Returns

Type	Description
Token