Class TermSuggestion.Entry.Option
- java.lang.Object
-
- org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option
-
- org.elasticsearch.search.suggest.term.TermSuggestion.Entry.Option
-
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentFragment
- Enclosing class:
- TermSuggestion.Entry
public static class TermSuggestion.Entry.Option extends Suggest.Suggestion.Entry.Option
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
FREQ
-
Fields inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option
COLLATE_MATCH, HIGHLIGHTED, SCORE, TEXT
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description Option(StreamInput in)
Option(Text text, int freq, float score)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TermSuggestion.Entry.Option
fromXContent(XContentParser parser)
int
getFreq()
protected void
mergeInto(Suggest.Suggestion.Entry.Option otherOption)
void
setFreq(int freq)
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.-
Methods inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option
collateMatch, equals, getHighlighted, getScore, getText, hashCode, setScore
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
FREQ
public static final ParseField FREQ
-
-
Constructor Detail
-
Option
public Option(Text text, int freq, float score)
-
Option
public Option(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
mergeInto
protected void mergeInto(Suggest.Suggestion.Entry.Option otherOption)
- Overrides:
mergeInto
in classSuggest.Suggestion.Entry.Option
-
setFreq
public void setFreq(int freq)
-
getFreq
public int getFreq()
- Returns:
- How often this suggested text appears in the index.
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classSuggest.Suggestion.Entry.Option
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Overrides:
toXContent
in classSuggest.Suggestion.Entry.Option
- Throws:
java.io.IOException
-
fromXContent
public static TermSuggestion.Entry.Option fromXContent(XContentParser parser)
-
-