org.elasticsearch.search.suggest.term

Class TermSuggestion

java.lang.Object

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

org.elasticsearch.search.suggest.term.TermSuggestion

All Implemented Interfaces:

Iterable<TermSuggestion.Entry>, Streamable, ToXContent

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

The suggestion responses corresponding with the suggestions in the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermSuggestion.Entry Represents a part from the suggest text with suggested options.
static class	TermSuggestion.Frequency
static class	TermSuggestion.Score

Nested classes/interfaces inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion

Suggest.Suggestion.Sort

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Suggest.Suggestion.Entry.Option>	FREQUENCY
static Comparator<Suggest.Suggestion.Entry.Option>	SCORE
static int	TYPE

Fields inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion

entries, name, size

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
TermSuggestion()
TermSuggestion(String name, int size, Suggest.Suggestion.Sort sort)

Method Summary

Methods

Modifier and Type	Method and Description
int	getType()
protected void	innerReadFrom(StreamInput in)
void	innerWriteTo(StreamOutput out)
protected TermSuggestion.Entry	newEntry()
protected Comparator<Suggest.Suggestion.Entry.Option>	sortComparator()

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

addTerm, getEntries, getName, iterator, readFrom, reduce, toXContent, trim, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

SCORE

public static final Comparator<Suggest.Suggestion.Entry.Option> SCORE

FREQUENCY

public static final Comparator<Suggest.Suggestion.Entry.Option> FREQUENCY

TYPE

public static final int TYPE

See Also:

Constant Field Values

Constructor Detail

TermSuggestion

public TermSuggestion()

TermSuggestion

public TermSuggestion(String name,
              int size,
              Suggest.Suggestion.Sort sort)

Method Detail

getType

public int getType()

Overrides:

getType in class Suggest.Suggestion<TermSuggestion.Entry>

sortComparator

protected Comparator<Suggest.Suggestion.Entry.Option> sortComparator()

Overrides:

sortComparator in class Suggest.Suggestion<TermSuggestion.Entry>

innerReadFrom

protected void innerReadFrom(StreamInput in)
                      throws IOException

Overrides:

innerReadFrom in class Suggest.Suggestion<TermSuggestion.Entry>

Throws:

IOException

innerWriteTo

public void innerWriteTo(StreamOutput out)
                  throws IOException

Overrides:

innerWriteTo in class Suggest.Suggestion<TermSuggestion.Entry>

Throws:

IOException

newEntry

protected TermSuggestion.Entry newEntry()

Overrides:

newEntry in class Suggest.Suggestion<TermSuggestion.Entry>