Package org.elasticsearch.search.suggest

Class SuggestBuilder

java.lang.Object
org.elasticsearch.search.suggest.SuggestBuilder
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class SuggestBuilder
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
Defines how to perform suggesting. This builders allows a number of global options to be specified and an arbitrary number of SuggestionBuilder instances.

Suggesting works by suggesting terms/phrases that appear in the suggest text that are similar compared to the terms in provided text. These suggestions are based on several options described in this class.

  • Nested Class Summary

    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
    protected static org.elasticsearch.common.ParseField GLOBAL_TEXT_FIELD  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    SuggestBuilder()
    Build an empty SuggestBuilder.
    SuggestBuilder​(StreamInput in)
    Read from a stream.

  • Method Summary

    Modifier and Type Method Description
    SuggestBuilder addSuggestion​(java.lang.String name, SuggestionBuilder<?> suggestion)
    Adds an SuggestionBuilder instance under a user defined name.
    SuggestionSearchContext build​(SearchExecutionContext context)  
    boolean equals​(java.lang.Object other)  
    static SuggestBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.lang.String getGlobalText()
    Gets the global suggest text
    java.util.Map<java.lang.String,​SuggestionBuilder<?>> getSuggestions()
    Get all the Suggestions that were added to the global SuggestBuilder, together with their names
    int hashCode()  
    SuggestBuilder setGlobalText​(java.lang.String globalText)
    Sets the text to provide suggestions for.
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

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

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

    isFragment

  • Field Details

    • GLOBAL_TEXT_FIELD

      protected static final org.elasticsearch.common.ParseField GLOBAL_TEXT_FIELD

  • Constructor Details

    • SuggestBuilder

      public SuggestBuilder()
      Build an empty SuggestBuilder.

    • SuggestBuilder

      public SuggestBuilder​(StreamInput in) throws java.io.IOException
      Read from a stream.
      Throws:
      java.io.IOException

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • setGlobalText

      public SuggestBuilder setGlobalText​(@Nullable java.lang.String globalText)
      Sets the text to provide suggestions for. The suggest text is a required option that needs to be set either via this setter or via the SuggestionBuilder.text(String) method.

      The suggest text gets analyzed by the suggest analyzer or the suggest field search analyzer. For each analyzed token, suggested terms are suggested if possible.

    • getGlobalText

      @Nullable public java.lang.String getGlobalText()
      Gets the global suggest text

    • addSuggestion

      public SuggestBuilder addSuggestion​(java.lang.String name, SuggestionBuilder<?> suggestion)
      Adds an SuggestionBuilder instance under a user defined name. The order in which the Suggestions are added, is the same as in the response.
      Throws:
      java.lang.IllegalArgumentException - if two suggestions added have the same name

    • getSuggestions

      public java.util.Map<java.lang.String,​SuggestionBuilder<?>> getSuggestions()
      Get all the Suggestions that were added to the global SuggestBuilder, together with their names

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static SuggestBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • build

      public SuggestionSearchContext build​(SearchExecutionContext context) throws java.io.IOException
      Throws:
      java.io.IOException

    • equals

      public boolean equals​(java.lang.Object other)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object