org.elasticsearch.search.suggest

Class Suggest

java.lang.Object

org.elasticsearch.search.suggest.Suggest

All Implemented Interfaces:

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

public class Suggest
extends java.lang.Object
implements java.lang.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.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

Modifier and Type	Field and Description
static java.util.Comparator<Suggest.Suggestion.Entry.Option>	COMPARATOR
static java.lang.String	NAME

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Suggest(java.util.List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions)

Method Summary

Modifier and Type	Method and Description
<T extends Suggest.Suggestion> java.util.List<T>	filter(java.lang.Class<T> suggestionType)
static Suggest	fromXContent(XContentParser parser) this parsing method assumes that the leading "suggest" field name has already been parsed by the caller
<T extends Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> T	getSuggestion(java.lang.String name)
boolean	hasScoreDocs() Whether any suggestions had query hits
java.util.Iterator<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>	iterator()
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
static Suggest	readSuggest(StreamInput in)
static java.util.List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>	reduce(java.util.Map<java.lang.String,java.util.List<Suggest.Suggestion>> groupedSuggestions)
int	size() The number of suggestions in this Suggest result
XContentBuilder	toInnerXContent(XContentBuilder builder, ToXContent.Params params) use to write suggestion entries without NAME object
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

COMPARATOR

public static final java.util.Comparator<Suggest.Suggestion.Entry.Option> COMPARATOR

Constructor Detail

Suggest

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

Method Detail

iterator

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

Specified by:

iterator in interface java.lang.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(java.lang.String name)

hasScoreDocs

public boolean hasScoreDocs()

Whether any suggestions had query hits

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toInnerXContent

public XContentBuilder toInnerXContent(XContentBuilder builder,
                                       ToXContent.Params params)
                                throws java.io.IOException

use to write suggestion entries without NAME object

Throws:

java.io.IOException

fromXContent

public static Suggest fromXContent(XContentParser parser)
                            throws java.io.IOException

this parsing method assumes that the leading "suggest" field name has already been parsed by the caller

Throws:

java.io.IOException

readSuggest

public static Suggest readSuggest(StreamInput in)
                           throws java.io.IOException

Throws:

java.io.IOException

reduce

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

filter

public <T extends Suggest.Suggestion> java.util.List<T> filter(java.lang.Class<T> suggestionType)

Returns:

only suggestions of type suggestionType contained in this Suggest instance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object