org.apache.lucene.search.suggest.document

Class TopSuggestDocs.SuggestScoreDoc

java.lang.Object

org.apache.lucene.search.ScoreDoc

org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc

All Implemented Interfaces:

java.lang.Comparable<TopSuggestDocs.SuggestScoreDoc>

Enclosing class:

TopSuggestDocs

public static class TopSuggestDocs.SuggestScoreDoc
extends ScoreDoc
implements java.lang.Comparable<TopSuggestDocs.SuggestScoreDoc>

ScoreDoc with an additional CharSequence key

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.CharSequence	context Context for the completion
java.lang.CharSequence	key Matched completion key

Fields inherited from class org.apache.lucene.search.ScoreDoc

doc, score, shardIndex

Constructor Summary

Constructors

Constructor and Description
SuggestScoreDoc(int doc, java.lang.CharSequence key, java.lang.CharSequence context, float score) Creates a SuggestScoreDoc instance

Method Summary

Modifier and Type	Method and Description
int	compareTo(TopSuggestDocs.SuggestScoreDoc o)

Methods inherited from class org.apache.lucene.search.ScoreDoc

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

key

public final java.lang.CharSequence key

Matched completion key

context

public final java.lang.CharSequence context

Context for the completion

Constructor Detail

SuggestScoreDoc

public SuggestScoreDoc(int doc,
                       java.lang.CharSequence key,
                       java.lang.CharSequence context,
                       float score)

Creates a SuggestScoreDoc instance

Parameters:

doc - document id (hit)

key - matched completion

score - weight of the matched completion

Method Detail

compareTo

public int compareTo(TopSuggestDocs.SuggestScoreDoc o)

Specified by:

compareTo in interface java.lang.Comparable<TopSuggestDocs.SuggestScoreDoc>