Package org.opensearch.example.customsuggester

Class CustomSuggestion.Entry

java.lang.Object

org.opensearch.search.suggest.Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option>

org.opensearch.example.customsuggester.CustomSuggestion.Entry

All Implemented Interfaces:

Iterable<CustomSuggestion.Entry.Option>, Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

Enclosing class:

CustomSuggestion

public static class CustomSuggestion.Entry
extends Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomSuggestion.Entry.Option

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

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

Field Summary

Fields inherited from class org.opensearch.search.suggest.Suggest.Suggestion.Entry

length, offset, options, OPTIONS, text

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Entry()
Entry(StreamInput in)
Entry(Text text, int offset, int length, String dummy)

Method Summary

Modifier and Type	Method	Description
static CustomSuggestion.Entry	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getDummy()	Meaningless field used to test that plugin suggesters can add fields to their entries
protected void	merge(Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option> otherEntry)
protected CustomSuggestion.Entry.Option	newOption(StreamInput in)
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.opensearch.search.suggest.Suggest.Suggestion.Entry

addOption, addOptions, declareCommonFields, equals, getLength, getOffset, getOptions, getText, hashCode, iterator, reduce, sort

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

Entry

public Entry()

Entry

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

Entry

public Entry(StreamInput in)
      throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option>

Throws:

IOException

newOption

protected CustomSuggestion.Entry.Option newOption(StreamInput in)
                                           throws IOException

Specified by:

newOption in class Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option>

Throws:

IOException

merge

protected void merge(Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option> otherEntry)

Overrides:

merge in class Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option>

getDummy

public String getDummy()

Meaningless field used to test that plugin suggesters can add fields to their entries

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Overrides:

toXContent in class Suggest.Suggestion.Entry<CustomSuggestion.Entry.Option>

Throws:

IOException

fromXContent

public static CustomSuggestion.Entry fromXContent(org.opensearch.core.xcontent.XContentParser parser)