Package org.elasticsearch.search.suggest.term

Class TermSuggestion

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

org.elasticsearch.search.suggest.term.TermSuggestion

All Implemented Interfaces:

<TermSuggestion.Entry>, NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

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

The suggestion responses corresponding with the suggestions in the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermSuggestion.Entry	Represents a part from the suggest text with suggested options.
static class	TermSuggestion.Frequency
static class	TermSuggestion.Score

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static <Suggest.Suggestion.Entry.Option>	FREQUENCY
static <Suggest.Suggestion.Entry.Option>	SCORE
static int	TYPE	Deprecated.

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

entries, name, size

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
name, int size, SortBy sort)
TermSuggestion(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	other)
static TermSuggestion	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, name)
SortBy	getSort()
	getWriteableName()	Returns the name of the writeable object
int	getWriteableType()	Returns a integer representing the type of the suggestion.
int	hashCode()
protected TermSuggestion.Entry	newEntry(StreamInput in)
void	setSort(SortBy sort)
protected <Suggest.Suggestion.Entry.Option>	sortComparator()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

addTerm, fromXContent, getEntries, getName, getSize, iterator, parseEntries, reduce, toXContent, trim

Methods inherited from class java.lang.

, , , , , , , ,

Methods inherited from interface java.lang.

,

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

TYPE

public static final int TYPE

Deprecated.

See Also:

Constant Field Values

SCORE

public static final <Suggest.Suggestion.Entry.Option> SCORE

FREQUENCY

public static final <Suggest.Suggestion.Entry.Option> FREQUENCY

Constructor Details

TermSuggestion

public TermSuggestion( name,
 int size,
 SortBy sort)

TermSuggestion

public TermSuggestion(StreamInput in)
               throws 

Throws:

Method Details

getWriteableType

public int getWriteableType()

Description copied from class: Suggest.Suggestion

Returns a integer representing the type of the suggestion. This is used for internal serialization over the network. This class is now serialized as a NamedWriteable and this method only remains for backwards compatibility

Overrides:

getWriteableType in class Suggest.Suggestion<TermSuggestion.Entry>

setSort

public void setSort(SortBy sort)

getSort

public SortBy getSort()

sortComparator

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

Overrides:

sortComparator in class Suggest.Suggestion<TermSuggestion.Entry>

writeTo

public void writeTo(StreamOutput out)
             throws 

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class Suggest.Suggestion<TermSuggestion.Entry>

Throws:

getWriteableName

public  getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in class Suggest.Suggestion<TermSuggestion.Entry>

fromXContent

public static TermSuggestion fromXContent(org.elasticsearch.common.xcontent.XContentParser parser,
  name)
                                   throws 

Throws:

newEntry

protected TermSuggestion.Entry newEntry(StreamInput in)
                                 throws 

Specified by:

newEntry in class Suggest.Suggestion<TermSuggestion.Entry>

Throws:

equals

public boolean equals( other)

Overrides:

equals in class Suggest.Suggestion<TermSuggestion.Entry>

hashCode

public int hashCode()

Overrides:

hashCode in class Suggest.Suggestion<TermSuggestion.Entry>