org.elasticsearch.search.suggest

クラス Suggest.Suggestion.Entry.Option

java.lang.Object

org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option

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

Streamable, ToXContent

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

CompletionSuggestion.Entry.Option, TermSuggestion.Entry.Option

含まれているクラス:

Suggest.Suggestion.Entry<O extends Suggest.Suggestion.Entry.Option>

public static class Suggest.Suggestion.Entry.Option
extends Object
implements Streamable, ToXContent

Contains the suggested text with its document frequency and score.

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

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

EMPTY_PARAMS

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

コンストラクタ

コンストラクタと説明
Option()
Option(Text text, float score)
Option(Text text, Text highlighted, float score)
Option(Text text, Text highlighted, float score, Boolean collateMatch)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	collateMatch()
boolean	equals(Object o)
Text	getHighlighted()
float	getScore()
Text	getText()
int	hashCode()
protected XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
protected void	mergeInto(Suggest.Suggestion.Entry.Option otherOption)
void	readFrom(StreamInput in)
protected void	setScore(float score)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

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

コンストラクタの詳細

Option

public Option(Text text,
              Text highlighted,
              float score,
              Boolean collateMatch)

Option

public Option(Text text,
              Text highlighted,
              float score)

Option

public Option(Text text,
              float score)

Option

public Option()

メソッドの詳細

getText

public Text getText()

戻り値:

The actual suggested text.

getHighlighted

public Text getHighlighted()

戻り値:

Copy of suggested text with changes from user supplied text highlighted.

getScore

public float getScore()

戻り値:

The score based on the edit distance difference between the suggested term and the term in the suggest text.

collateMatch

public boolean collateMatch()

戻り値:

true if collation has found a match for the entry. if collate was not set, the value defaults to true

setScore

protected void setScore(float score)

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

例外:

IOException

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

innerToXContent

protected XContentBuilder innerToXContent(XContentBuilder builder,
                                          ToXContent.Params params)
                                   throws IOException

例外:

IOException

mergeInto

protected void mergeInto(Suggest.Suggestion.Entry.Option otherOption)

equals

public boolean equals(Object o)

オーバーライド:

equals クラス内 Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object