org.elasticsearch.search.suggest

Class Suggest.Suggestion<T extends Suggest.Suggestion.Entry>

java.lang.Object

org.elasticsearch.search.suggest.Suggest.Suggestion<T>

All Implemented Interfaces:

Iterable<T>, Streamable, ToXContent

Direct Known Subclasses:

CompletionSuggestion, PhraseSuggestion, TermSuggestion

Enclosing class:

Suggest

public static class Suggest.Suggestion<T extends Suggest.Suggestion.Entry>
extends Object
implements Iterable<T>, Streamable, ToXContent

The suggestion responses corresponding with the suggestions in the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Suggest.Suggestion.Entry<O extends Suggest.Suggestion.Entry.Option> Represents a part from the suggest text with suggested options.
static class	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
protected List<T>	entries
protected String	name
protected int	size
static int	TYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addTerm(T entry)
List<T>	getEntries()
String	getName()
int	getType()
protected void	innerReadFrom(StreamInput in)
void	innerWriteTo(StreamOutput out)
Iterator<T>	iterator()
protected T	newEntry()
void	readFrom(StreamInput in)
Suggest.Suggestion<T>	reduce(List<Suggest.Suggestion<T>> toReduce) Merges the result of another suggestion into this suggestion.
protected Comparator<Suggest.Suggestion.Entry.Option>	sortComparator()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	trim() Trims the number of options per suggest text term to the requested size.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final int TYPE

See Also:

Constant Field Values

name

protected String name

size

protected int size

entries

protected final List<T extends Suggest.Suggestion.Entry> entries

Constructor Detail

Suggest.Suggestion

public Suggest.Suggestion()

Suggest.Suggestion

public Suggest.Suggestion(String name,
                  int size)

Method Detail

addTerm

public void addTerm(T entry)

getType

public int getType()

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Suggest.Suggestion.Entry>

getEntries

public List<T> getEntries()

Returns:

The entries for this suggestion.

getName

public String getName()

Returns:

The name of the suggestion as is defined in the request.

reduce

public Suggest.Suggestion<T> reduce(List<Suggest.Suggestion<T>> toReduce)

Merges the result of another suggestion into this suggestion. For internal usage.

sortComparator

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

trim

public void trim()

Trims the number of options per suggest text term to the requested size. For internal usage.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

newEntry

protected T newEntry()

innerReadFrom

protected void innerReadFrom(StreamInput in)
                      throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

innerWriteTo

public void innerWriteTo(StreamOutput out)
                  throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException