java.lang.Object
org.elasticsearch.search.suggest.Suggest
- All Implemented Interfaces:
Iterable<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>,Writeable,ToXContent,ToXContentFragment
public final class Suggest
extends Object
implements Iterable<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>, Writeable, ToXContentFragment
Top level suggest result, containing the result for each suggestion.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classSuggest.Suggestion<T extends Suggest.Suggestion.Entry>The suggestion responses corresponding with the suggestions in the request.Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Comparator<Suggest.Suggestion.Entry.Option> static final StringFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionSuggest(List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions) Suggest(StreamInput in) -
Method Summary
Modifier and TypeMethodDescriptionboolean<T extends Suggest.Suggestion>
List<T> <T extends Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>
TgetSuggestion(String name) inthashCode()booleanWhether any suggestions had query hitsIterator<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> iterator()static List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> reduce(Map<String, List<Suggest.Suggestion<?>>> groupedSuggestions) intsize()The number of suggestions in thisSuggestresulttoString()toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
COMPARATOR
-
-
Constructor Details
-
Suggest
public Suggest(List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> suggestions) -
Suggest
- Throws:
IOException
-
-
Method Details
-
iterator
public Iterator<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> iterator()- Specified by:
iteratorin interfaceIterable<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>>
-
size
public int size()The number of suggestions in thisSuggestresult -
getSuggestion
public <T extends Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> T getSuggestion(String name) -
hasScoreDocs
public boolean hasScoreDocs()Whether any suggestions had query hits -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
reduce
public static List<Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>> reduce(Map<String, List<Suggest.Suggestion<?>>> groupedSuggestions) -
filter
- Returns:
- only suggestions of type
suggestionTypecontained in thisSuggestinstance
-
equals
-
hashCode
public int hashCode() -
toString
-