org.apache.lucene.search.highlight

Class TokenGroup

public class TokenGroup extends Object

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

Author: MAHarwood

Method Detail

public int getEndOffset()

Returns: the end position in the original text

public int getNumTokens()

Returns: the number of tokens in this group

public float getScore(int index)

Parameters: index a value between 0 and numTokens -1

Returns: the "n"th score

public int getStartOffset()

Returns: the start position in the original text

public Token getToken(int index)

Parameters: index a value between 0 and numTokens -1

Returns: the "n"th token

public float getTotalScore()

Returns: all tokens' scores summed up