org.elasticsearch.search.suggest

Class Suggest

java.lang.Object

org.elasticsearch.search.suggest.Suggest

All Implemented Interfaces:

Iterable<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>, Streamable, ToXContent

public class Suggest
extends Object
implements Iterable<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>, Streamable, ToXContent

Top level suggest result, containing the result for each suggestion.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Suggest.Fields
static class	Suggest.Suggestion<T extends Suggest.Suggestion.Entry> The suggestion responses corresponding with the suggestions in the request.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Suggest()
Suggest(List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions)
Suggest(XContentBuilderString name)
Suggest(XContentBuilderString name, List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> T	getSuggestion(String name)
static Map<String,List<Suggest.Suggestion>>	group(Map<String,List<Suggest.Suggestion>> groupedSuggestions, Suggest suggest)
Iterator<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>	iterator()
void	readFrom(StreamInput in)
static Suggest	readSuggest(XContentBuilderString name, StreamInput in)
static List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>	reduce(Map<String,List<Suggest.Suggestion>> groupedSuggestions)
int	size() The number of suggestions in this Suggest result
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Suggest

public Suggest()

Suggest

public Suggest(XContentBuilderString name)

Suggest

public Suggest(List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions)

Suggest

public Suggest(XContentBuilderString name,
       List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions)

Method Detail

iterator

public Iterator<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> iterator()

Specified by:

iterator in interface Iterable<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>

size

public int size()

The number of suggestions in this Suggest result

getSuggestion

public <T extends Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> T getSuggestion(String name)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readSuggest

public static Suggest readSuggest(XContentBuilderString name,
                  StreamInput in)
                           throws IOException

Throws:

IOException

group

public static Map<String,List<Suggest.Suggestion>> group(Map<String,List<Suggest.Suggestion>> groupedSuggestions,
                                         Suggest suggest)

reduce

public static List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> reduce(Map<String,List<Suggest.Suggestion>> groupedSuggestions)

toString

public String toString()

Overrides:

toString in class Object