Class TokenGroup

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

Inheritance
System.Object
TokenGroup
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Search.Highlight
Assembly: Lucene.Net.Highlighter.dll
Syntax
public class TokenGroup

Constructors

| Improve this Doc View Source

TokenGroup(TokenStream)

Declaration
public TokenGroup(TokenStream tokenStream)
Parameters
Type Name Description
Lucene.Net.Analysis.TokenStream tokenStream

Properties

| Improve this Doc View Source

EndOffset

the end position in the original text

Declaration
public virtual int EndOffset { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

NumTokens

the number of tokens in this group

Declaration
public virtual int NumTokens { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

StartOffset

the start position in the original text

Declaration
public virtual int StartOffset { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TotalScore

all tokens' scores summed up

Declaration
public virtual float TotalScore { get; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

GetScore(Int32)

the "n"th score

Declaration
public virtual float GetScore(int index)
Parameters
Type Name Description
System.Int32 index

a value between 0 and numTokens -1
Returns
Type Description
System.Single
| Improve this Doc View Source

GetToken(Int32)

the "n"th token

Declaration
public virtual Token GetToken(int index)
Parameters
Type Name Description
System.Int32 index

a value between 0 and numTokens -1
Returns
Type Description
Lucene.Net.Analysis.Token