org.elasticsearch.search.suggest

Class SuggestBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.suggest.SuggestBuilder

All Implemented Interfaces:

Writeable, ToXContent

public class SuggestBuilder
extends ToXContentToBytes
implements Writeable

Defines how to perform suggesting. This builders allows a number of global options to be specified and an arbitrary number of SuggestionBuilder instances.

Suggesting works by suggesting terms/phrases that appear in the suggest text that are similar compared to the terms in provided text. These suggestions are based on several options described in this class.

Nested Class Summary

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

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

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
protected static ParseField	GLOBAL_TEXT_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SuggestBuilder() Build an empty SuggestBuilder.
SuggestBuilder(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
SuggestBuilder	addSuggestion(java.lang.String name, SuggestionBuilder<?> suggestion) Adds an SuggestionBuilder instance under a user defined name.
SuggestionSearchContext	build(QueryShardContext context)
boolean	equals(java.lang.Object other)
static SuggestBuilder	fromXContent(QueryParseContext parseContext, Suggesters suggesters)
java.lang.String	getGlobalText() Gets the global suggest text
java.util.Map<java.lang.String,SuggestionBuilder<?>>	getSuggestions() Get all the Suggestions that were added to the global SuggestBuilder, together with their names
int	hashCode()
SuggestBuilder	setGlobalText(java.lang.String globalText) Sets the text to provide suggestions for.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_TEXT_FIELD

protected static final ParseField GLOBAL_TEXT_FIELD

Constructor Detail

SuggestBuilder

public SuggestBuilder()

Build an empty SuggestBuilder.

SuggestBuilder

public SuggestBuilder(StreamInput in)
               throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

setGlobalText

public SuggestBuilder setGlobalText(@Nullable
                                    java.lang.String globalText)

Sets the text to provide suggestions for. The suggest text is a required option that needs to be set either via this setter or via the SuggestionBuilder.text(String) method.

The suggest text gets analyzed by the suggest analyzer or the suggest field search analyzer. For each analyzed token, suggested terms are suggested if possible.

getGlobalText

@Nullable
public java.lang.String getGlobalText()

Gets the global suggest text

addSuggestion

public SuggestBuilder addSuggestion(java.lang.String name,
                                    SuggestionBuilder<?> suggestion)

Adds an SuggestionBuilder instance under a user defined name. The order in which the Suggestions are added, is the same as in the response.

Throws:

java.lang.IllegalArgumentException - if two suggestions added have the same name

getSuggestions

public java.util.Map<java.lang.String,SuggestionBuilder<?>> getSuggestions()

Get all the Suggestions that were added to the global SuggestBuilder, together with their names

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static SuggestBuilder fromXContent(QueryParseContext parseContext,
                                          Suggesters suggesters)
                                   throws java.io.IOException

Throws:

java.io.IOException

build

public SuggestionSearchContext build(QueryShardContext context)
                              throws java.io.IOException

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object