Package org.apache.lucene.search.suggest
Class Lookup.LookupResult
- java.lang.Object
-
- org.apache.lucene.search.suggest.Lookup.LookupResult
-
- All Implemented Interfaces:
Comparable<Lookup.LookupResult>
- Enclosing class:
- Lookup
public static final class Lookup.LookupResult extends Object implements Comparable<Lookup.LookupResult>
Result of a lookup.
-
-
Field Summary
Fields Modifier and Type Field Description Object
highlightKey
Expert: custom Object to hold the result of a highlighted suggestion.CharSequence
key
the key's textBytesRef
payload
the key's payload (null if not present)long
value
the key's weight
-
Constructor Summary
Constructors Constructor Description LookupResult(CharSequence key, long value)
Create a new result from a key+weight pair.LookupResult(CharSequence key, long value, BytesRef payload)
Create a new result from a key+weight+payload triple.LookupResult(CharSequence key, Object highlightKey, long value, BytesRef payload)
Create a new result from a key+highlightKey+weight+payload triple.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Lookup.LookupResult o)
Compare alphabetically.String
toString()
-
-
-
Field Detail
-
key
public final CharSequence key
the key's text
-
highlightKey
public final Object highlightKey
Expert: custom Object to hold the result of a highlighted suggestion.
-
value
public final long value
the key's weight
-
payload
public final BytesRef payload
the key's payload (null if not present)
-
-
Constructor Detail
-
LookupResult
public LookupResult(CharSequence key, long value)
Create a new result from a key+weight pair.
-
LookupResult
public LookupResult(CharSequence key, long value, BytesRef payload)
Create a new result from a key+weight+payload triple.
-
LookupResult
public LookupResult(CharSequence key, Object highlightKey, long value, BytesRef payload)
Create a new result from a key+highlightKey+weight+payload triple.
-
-
Method Detail
-
compareTo
public int compareTo(Lookup.LookupResult o)
Compare alphabetically.- Specified by:
compareTo
in interfaceComparable<Lookup.LookupResult>
-
-