Package org.elasticsearch.search.suggest.term

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, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 org.elasticsearch.common.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

Modifier and Type	Method	Description
static TermSuggestion.Entry.Option	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
int	getFreq()
protected void	mergeInto(Suggest.Suggestion.Entry.Option otherOption)
void	setFreq(int freq)
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 Details

FREQ

public static final org.elasticsearch.common.ParseField FREQ

Constructor Details

Option

public Option(Text text,
int freq,
float score)

Option

public Option(StreamInput in)
       throws java.io.IOException

Throws:

java.io.IOException

Method Details

mergeInto

protected void mergeInto(Suggest.Suggestion.Entry.Option otherOption)

Overrides:

mergeInto in class Suggest.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 interface Writeable

Overrides:

writeTo in class Suggest.Suggestion.Entry.Option

Throws:

java.io.IOException

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws java.io.IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Overrides:

toXContent in class Suggest.Suggestion.Entry.Option

Throws:

java.io.IOException

fromXContent

public static TermSuggestion.Entry.Option fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)