Package org.elasticsearch.search.suggest.term

Class TermSuggestion.Entry

java.lang.Object

org.elasticsearch.search.suggest.Suggest.Suggestion.Entry<TermSuggestion.Entry.Option>

org.elasticsearch.search.suggest.term.TermSuggestion.Entry

All Implemented Interfaces:

Iterable<TermSuggestion.Entry.Option>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

Enclosing class:

TermSuggestion

public static class TermSuggestion.Entry
extends Suggest.Suggestion.Entry<TermSuggestion.Entry.Option>

Represents a part from the suggest text with suggested options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermSuggestion.Entry.Option	Contains the suggested text with its document frequency and score.

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 inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion.Entry

length, offset, options, OPTIONS, text

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Entry(StreamInput in)
Entry(Text text, int offset, int length)

Method Summary

Modifier and Type	Method	Description
static TermSuggestion.Entry	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
protected TermSuggestion.Entry.Option	newOption(StreamInput in)

Methods inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion.Entry

addOption, addOptions, declareCommonFields, equals, getLength, getOffset, getOptions, getText, hashCode, iterator, merge, reduce, sort, toXContent, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

Entry

public Entry(Text text,
 int offset,
 int length)

Entry

public Entry(StreamInput in)
      throws IOException

Throws:

IOException

Method Details

newOption

protected TermSuggestion.Entry.Option newOption(StreamInput in)
                                         throws IOException

Specified by:

newOption in class Suggest.Suggestion.Entry<TermSuggestion.Entry.Option>

Throws:

IOException

fromXContent

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