Package org.opensearch.example.customsuggester

Class CustomSuggestion

java.lang.Object

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

org.opensearch.example.customsuggester.CustomSuggestion

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomSuggestion.Entry

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

Modifier and Type	Field	Description
static final org.opensearch.core.ParseField	DUMMY
static final int	TYPE

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

entries, name, size

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CustomSuggestion(String name, int size, String dummy)
CustomSuggestion(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static CustomSuggestion	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String name)
String	getDummy()	A meaningless value used to test that plugin suggesters can add fields to their Suggestion types This can't be serialized to xcontent because Suggestions appear in xcontent as an array of entries, so there is no place to add a custom field.
String	getWriteableName()
int	getWriteableType()
protected CustomSuggestion.Entry	newEntry(StreamInput in)
void	writeTo(StreamOutput out)

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

addTerm, equals, fromXContent, getEntries, getName, getSize, hashCode, iterator, parseEntries, reduce, sortComparator, toXContent, trim

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

Field Details

TYPE

public static final int TYPE

See Also:

• Constant Field Values

DUMMY

public static final org.opensearch.core.ParseField DUMMY

Constructor Details

CustomSuggestion

public CustomSuggestion(String name,
 int size,
 String dummy)

CustomSuggestion

public CustomSuggestion(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<CustomSuggestion.Entry>

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in class Suggest.Suggestion<CustomSuggestion.Entry>

getWriteableType

public int getWriteableType()

Overrides:

getWriteableType in class Suggest.Suggestion<CustomSuggestion.Entry>

getDummy

public String getDummy()

A meaningless value used to test that plugin suggesters can add fields to their Suggestion types This can't be serialized to xcontent because Suggestions appear in xcontent as an array of entries, so there is no place to add a custom field. But we can still use a custom field internally and use it to define a Suggestion's behavior

newEntry

protected CustomSuggestion.Entry newEntry(StreamInput in)
                                   throws IOException

Specified by:

newEntry in class Suggest.Suggestion<CustomSuggestion.Entry>

Throws:

IOException

fromXContent

public static CustomSuggestion fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String name)
                                     throws IOException

Throws:

IOException