org.elasticsearch.search.suggest

クラス SuggestBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.suggest.SuggestBuilder

すべての実装されたインタフェース:

ToXContent

public class SuggestBuilder
extends ToXContentToBytes

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

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

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	SuggestBuilder.SuggestionBuilder<T>

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SuggestBuilder()
SuggestBuilder(String name)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
SuggestBuilder	addSuggestion(SuggestBuilder.SuggestionBuilder<?> suggestion) Adds an TermSuggestionBuilder instance under a user defined name.
List<SuggestBuilder.SuggestionBuilder<?>>	getSuggestion() Returns all suggestions with the defined names.
SuggestBuilder	setText(String globalText) Sets the text to provide suggestions for.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

クラスから継承されたメソッド org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

SuggestBuilder

public SuggestBuilder()

SuggestBuilder

public SuggestBuilder(String name)

メソッドの詳細

setText

public SuggestBuilder setText(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 setText(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.

addSuggestion

public SuggestBuilder addSuggestion(SuggestBuilder.SuggestionBuilder<?> suggestion)

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

getSuggestion

public List<SuggestBuilder.SuggestionBuilder<?>> getSuggestion()

Returns all suggestions with the defined names.

toXContent

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

例外:

IOException