org.elasticsearch.search.suggest.completion

Class CompletionSuggestion

java.lang.Object

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

org.elasticsearch.search.suggest.completion.CompletionSuggestion

All Implemented Interfaces:

java.lang.Iterable<CompletionSuggestion.Entry>, Streamable, ToXContent

public final class CompletionSuggestion
extends Suggest.Suggestion<CompletionSuggestion.Entry>

Suggestion response for CompletionSuggester results Response format for each entry: { "text" : STRING "score" : FLOAT "contexts" : CONTEXTS } CONTEXTS : { "CONTEXT_NAME" : ARRAY, .. }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompletionSuggestion.Entry

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.lang.String	NAME
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
CompletionSuggestion()
CompletionSuggestion(java.lang.String name, int size)

Method Summary

Modifier and Type	Method and Description
static CompletionSuggestion	fromXContent(XContentParser parser, java.lang.String name)
java.util.List<CompletionSuggestion.Entry.Option>	getOptions()
protected java.lang.String	getType() Returns a string representing the type of the suggestion.
int	getWriteableType() Returns a integer representing the type of the suggestion.
boolean	hasScoreDocs()
protected CompletionSuggestion.Entry	newEntry()
Suggest.Suggestion<CompletionSuggestion.Entry>	reduce(java.util.List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce) Merges the result of another suggestion into this suggestion.
static CompletionSuggestion	reduceTo(java.util.List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce) Reduces suggestions to a single suggestion containing at most top Suggest.Suggestion.getSize() options across toReduce
void	setShardIndex(int shardIndex)

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

addTerm, fromXContent, getEntries, getName, getSize, innerReadFrom, innerWriteTo, iterator, parseEntries, readFrom, sortComparator, toXContent, trim, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

TYPE

public static final int TYPE

See Also:

Constant Field Values

Constructor Detail

CompletionSuggestion

public CompletionSuggestion()

CompletionSuggestion

public CompletionSuggestion(java.lang.String name,
                            int size)

Method Detail

getOptions

public java.util.List<CompletionSuggestion.Entry.Option> getOptions()

Returns:

the result options for the suggestion

hasScoreDocs

public boolean hasScoreDocs()

Returns:

whether there is any hits for the suggestion

fromXContent

public static CompletionSuggestion fromXContent(XContentParser parser,
                                                java.lang.String name)
                                         throws java.io.IOException

Throws:

java.io.IOException

reduceTo

public static CompletionSuggestion reduceTo(java.util.List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce)

Reduces suggestions to a single suggestion containing at most top Suggest.Suggestion.getSize() options across toReduce

reduce

public Suggest.Suggestion<CompletionSuggestion.Entry> reduce(java.util.List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce)

Description copied from class: Suggest.Suggestion

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

Overrides:

reduce in class Suggest.Suggestion<CompletionSuggestion.Entry>

setShardIndex

public void setShardIndex(int shardIndex)

getWriteableType

public int getWriteableType()

Description copied from class: Suggest.Suggestion

Returns a integer representing the type of the suggestion. This is used for internal serialization over the network.

Overrides:

getWriteableType in class Suggest.Suggestion<CompletionSuggestion.Entry>

getType

protected java.lang.String getType()

Description copied from class: Suggest.Suggestion

Returns a string representing the type of the suggestion. This type is added to the suggestion name in the XContent response, so that it can later be used by REST clients to determine the internal type of the suggestion.

Overrides:

getType in class Suggest.Suggestion<CompletionSuggestion.Entry>

newEntry

protected CompletionSuggestion.Entry newEntry()

Overrides:

newEntry in class Suggest.Suggestion<CompletionSuggestion.Entry>