org.elasticsearch.search.suggest

クラス Suggest.Suggestion.Entry<O extends Suggest.Suggestion.Entry.Option>

java.lang.Object

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

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

Iterable<O>, Streamable, ToXContent

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

CompletionSuggestion.Entry, PhraseSuggestion.Entry, TermSuggestion.Entry

含まれているクラス:

Suggest.Suggestion<T extends Suggest.Suggestion.Entry>

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

Represents a part from the suggest text with suggested options.

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	Suggest.Suggestion.Entry.Option Contains the suggested text with its document frequency and score.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	length
protected int	offset
protected List<O>	options
protected Text	text

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

EMPTY_PARAMS

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

コンストラクタ

コンストラクタと説明
Entry()
Entry(Text text, int offset, int length)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addOption(O option)
boolean	equals(Object o)
int	getLength()
int	getOffset()
List<O>	getOptions()
Text	getText()
int	hashCode()
Iterator<O>	iterator()
protected void	merge(Suggest.Suggestion.Entry<O> other) Merge any extra fields for this subtype.
protected O	newOption()
void	readFrom(StreamInput in)
protected <T extends Suggest.Suggestion.Entry<O>> Suggest.Suggestion.Entry<O>	reduce(List<T> toReduce)
protected void	sort(Comparator<O> comparator)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

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

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

forEach, spliterator

フィールドの詳細

text

protected Text text

offset

protected int offset

length

protected int length

options

protected List<O extends Suggest.Suggestion.Entry.Option> options

コンストラクタの詳細

Entry

public Entry(Text text,
             int offset,
             int length)

Entry

public Entry()

メソッドの詳細

addOption

public void addOption(O option)

sort

protected void sort(Comparator<O> comparator)

reduce

protected <T extends Suggest.Suggestion.Entry<O>> Suggest.Suggestion.Entry<O> reduce(List<T> toReduce)

merge

protected void merge(Suggest.Suggestion.Entry<O> other)

Merge any extra fields for this subtype.

getText

public Text getText()

戻り値:

the text (analyzed by suggest analyzer) originating from the suggest text. Usually this is a single term.

getOffset

public int getOffset()

戻り値:

the start offset (not analyzed) for this entry in the suggest text.

getLength

public int getLength()

戻り値:

the length (not analyzed) for this entry in the suggest text.

iterator

public Iterator<O> iterator()

定義:

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

getOptions

public List<O> getOptions()

戻り値:

The suggested options for this particular suggest entry. If there are no suggested terms then an empty list is returned.

equals

public boolean equals(Object o)

オーバーライド:

equals クラス内 Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

例外:

IOException

newOption

protected O newOption()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

例外:

IOException

toXContent

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

定義:

toXContent インタフェース内 ToXContent

例外:

IOException