Package org.elasticsearch.search.suggest
Class Suggest.Suggestion.Entry.Option
java.lang.Object
org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentFragment
- Direct Known Subclasses:
CompletionSuggestion.Entry.Option
,PhraseSuggestion.Entry.Option
,TermSuggestion.Entry.Option
- Enclosing class:
- Suggest.Suggestion.Entry<O extends Suggest.Suggestion.Entry.Option>
public abstract static class Suggest.Suggestion.Entry.Option extends java.lang.Object implements Writeable, ToXContentFragment
Contains the suggested text with its document frequency and score.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static ParseField
COLLATE_MATCH
static ParseField
HIGHLIGHTED
static ParseField
SCORE
static ParseField
TEXT
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description boolean
collateMatch()
boolean
equals(java.lang.Object o)
Text
getHighlighted()
float
getScore()
Text
getText()
int
hashCode()
protected void
mergeInto(Suggest.Suggestion.Entry.Option otherOption)
protected void
setScore(float score)
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
Constructor Details
-
Method Details
-
getText
- Returns:
- The actual suggested text.
-
getHighlighted
- Returns:
- Copy of suggested text with changes from user supplied text highlighted.
-
getScore
public float getScore()- Returns:
- The score based on the edit distance difference between the suggested term and the term in the suggest text.
-
collateMatch
public boolean collateMatch()- Returns:
- true if collation has found a match for the entry.
if collate was not set, the value defaults to
true
-
setScore
protected void setScore(float score) -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
mergeInto
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-