Module org.elasticsearch.server

Package 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:

Iterable<CompletionSuggestion.Entry>, NamedWriteable, Writeable, ToXContent, ToXContentFragment

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	Description
static final class	CompletionSuggestion.Entry

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

entries, name, size, TYPE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CompletionSuggestion(String name, int size, boolean skipDuplicates)	Creates a completion suggestion given its name, size and whether it should skip duplicates
CompletionSuggestion(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static CompletionSuggestion	fromXContent(XContentParser parser, String name)
List<CompletionSuggestion.Entry.Option>	getOptions()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
boolean	hasScoreDocs()
protected CompletionSuggestion.Entry	newEntry(StreamInput in)
CompletionSuggestion	reduce(List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce)	Merges the result of another suggestion into this suggestion.
void	setShardIndex(int shardIndex)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

addTerm, fromXContent, getEntries, getName, getSize, iterator, parseEntries, sortComparator, toXContent, trim

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

CompletionSuggestion

public CompletionSuggestion(String name,
 int size,
 boolean skipDuplicates)

Creates a completion suggestion given its name, size and whether it should skip duplicates

Parameters:

name - The name for the suggestions

size - The number of suggestions to return

skipDuplicates - Whether duplicate suggestions should be filtered out

CompletionSuggestion

public CompletionSuggestion(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in class Suggest.Suggestion<CompletionSuggestion.Entry>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class Suggest.Suggestion<CompletionSuggestion.Entry>

Throws:

IOException

getOptions

public 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

equals

public boolean equals(Object other)

Overrides:

equals in class Suggest.Suggestion<CompletionSuggestion.Entry>

hashCode

public int hashCode()

Overrides:

hashCode in class Suggest.Suggestion<CompletionSuggestion.Entry>

fromXContent

public static CompletionSuggestion fromXContent(XContentParser parser,
 String name)
                                         throws IOException

Throws:

IOException

reduce

public CompletionSuggestion reduce(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)

newEntry

protected CompletionSuggestion.Entry newEntry(StreamInput in)
                                       throws IOException

Specified by:

newEntry in class Suggest.Suggestion<CompletionSuggestion.Entry>

Throws:

IOException