org.elasticsearch.search.suggest

クラス Suggest.Suggestion<T extends Suggest.Suggestion.Entry>

java.lang.Object

org.elasticsearch.search.suggest.Suggest.Suggestion<T>

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

Iterable<T>, Streamable, ToXContent

直系の既知のサブクラス:

CompletionSuggestion, PhraseSuggestion, TermSuggestion

含まれているクラス:

Suggest

public static class Suggest.Suggestion<T extends Suggest.Suggestion.Entry>
extends Object
implements Iterable<T>, Streamable, ToXContent

The suggestion responses corresponding with the suggestions in the request.

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	Suggest.Suggestion.Entry<O extends Suggest.Suggestion.Entry.Option> Represents a part from the suggest text with suggested options.
static class	Suggest.Suggestion.Sort

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected List<T>	entries
protected String	name
protected int	size
static int	TYPE

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

EMPTY_PARAMS

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

コンストラクタ

コンストラクタと説明
Suggestion()
Suggestion(String name, int size)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addTerm(T entry)
List<T>	getEntries()
String	getName()
int	getType()
protected void	innerReadFrom(StreamInput in)
void	innerWriteTo(StreamOutput out)
Iterator<T>	iterator()
protected T	newEntry()
void	readFrom(StreamInput in)
Suggest.Suggestion<T>	reduce(List<Suggest.Suggestion<T>> toReduce) Merges the result of another suggestion into this suggestion.
protected Comparator<Suggest.Suggestion.Entry.Option>	sortComparator()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	trim() Trims the number of options per suggest text term to the requested size.
void	writeTo(StreamOutput out)

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

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

インタフェースから継承されたメソッド java.lang.Iterable

forEach, spliterator

フィールドの詳細

TYPE

public static final int TYPE

関連項目:

定数フィールド値

name

protected String name

size

protected int size

entries

protected final List<T extends Suggest.Suggestion.Entry> entries

コンストラクタの詳細

Suggestion

public Suggestion()

Suggestion

public Suggestion(String name,
                  int size)

メソッドの詳細

addTerm

public void addTerm(T entry)

getType

public int getType()

iterator

public Iterator<T> iterator()

定義:

iterator インタフェース内 Iterable<T extends Suggest.Suggestion.Entry>

getEntries

public List<T> getEntries()

戻り値:

The entries for this suggestion.

getName

public String getName()

戻り値:

The name of the suggestion as is defined in the request.

reduce

public Suggest.Suggestion<T> reduce(List<Suggest.Suggestion<T>> toReduce)

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

sortComparator

protected Comparator<Suggest.Suggestion.Entry.Option> sortComparator()

trim

public void trim()

Trims the number of options per suggest text term to the requested size. For internal usage.

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

例外:

IOException

newEntry

protected T newEntry()

innerReadFrom

protected void innerReadFrom(StreamInput in)
                      throws IOException

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

例外:

IOException

innerWriteTo

public void innerWriteTo(StreamOutput out)
                  throws IOException

例外:

IOException

toXContent

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

定義:

toXContent インタフェース内 ToXContent

例外:

IOException