Package org.elasticsearch.search.suggest

Class SuggestionBuilder<T extends SuggestionBuilder<T>>

java.lang.Object
org.elasticsearch.search.suggest.SuggestionBuilder<T>
All Implemented Interfaces:
NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Direct Known Subclasses:
CompletionSuggestionBuilder, PhraseSuggestionBuilder, TermSuggestionBuilder
public abstract class SuggestionBuilder<T extends SuggestionBuilder<T>>
extends java.lang.Object
implements NamedWriteable, org.elasticsearch.common.xcontent.ToXContentFragment
Base class for the different suggestion implementations.

  • 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 java.lang.String analyzer  
    protected static org.elasticsearch.common.ParseField ANALYZER_FIELD  
    protected java.lang.String field  
    protected static org.elasticsearch.common.ParseField FIELDNAME_FIELD  
    protected java.lang.String prefix  
    protected static org.elasticsearch.common.ParseField PREFIX_FIELD  
    protected java.lang.String regex  
    protected static org.elasticsearch.common.ParseField REGEX_FIELD  
    protected java.lang.Integer shardSize  
    protected static org.elasticsearch.common.ParseField SHARDSIZE_FIELD  
    protected java.lang.Integer size  
    protected static org.elasticsearch.common.ParseField SIZE_FIELD  
    protected java.lang.String text  
    protected static org.elasticsearch.common.ParseField TEXT_FIELD  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Modifier Constructor Description
    protected SuggestionBuilder​(java.lang.String field)
    Creates a new suggestion.
    protected SuggestionBuilder​(java.lang.String field, SuggestionBuilder<?> in)
    internal copy constructor that copies over all class fields from second SuggestionBuilder except field name.
    protected SuggestionBuilder​(StreamInput in)
    Read from a stream.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String analyzer()
    get the analyzer() parameter
    T analyzer​(java.lang.String analyzer)
    Sets the analyzer to analyse to suggest text with.
    protected abstract SuggestionSearchContext.SuggestionContext build​(SearchExecutionContext context)  
    protected abstract boolean doEquals​(T other)
    Indicates whether some other SuggestionBuilder of the same type is "equal to" this one.
    protected abstract int doHashCode()
    HashCode for the subclass of SuggestionBuilder to implement.
    protected abstract void doWriteTo​(StreamOutput out)  
    boolean equals​(java.lang.Object obj)  
    java.lang.String field()
    get the field() parameter
    int hashCode()  
    protected abstract org.elasticsearch.common.xcontent.XContentBuilder innerToXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    protected void populateCommonFields​(SearchExecutionContext context, SuggestionSearchContext.SuggestionContext suggestionContext)
    Transfers the text, prefix, regex, analyzer, field, size and shard size settings from the original SuggestionBuilder to the target SuggestionSearchContext.SuggestionContext
    java.lang.String prefix()
    get the prefix for this suggestion
    protected T prefix​(java.lang.String prefix)  
    java.lang.String regex()
    get the regex for this suggestion
    protected T regex​(java.lang.String regex)  
    java.lang.Integer shardSize()
    get the shardSize() parameter
    T shardSize​(java.lang.Integer shardSize)
    Sets the maximum number of suggested term to be retrieved from each individual shard.
    java.lang.Integer size()
    get the size() parameter
    T size​(int size)
    Sets the maximum suggestions to be returned per suggest text term.
    java.lang.String text()
    get the text for this suggestion
    T text​(java.lang.String text)
    Same as in SuggestBuilder.setGlobalText(String), but in the suggestion scope.
    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, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

    getWriteableName

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

    isFragment

  • Field Details

    • field

      protected final java.lang.String field

    • text

      protected java.lang.String text

    • prefix

      protected java.lang.String prefix

    • regex

      protected java.lang.String regex

    • analyzer

      protected java.lang.String analyzer

    • size

      protected java.lang.Integer size

    • shardSize

      protected java.lang.Integer shardSize

    • TEXT_FIELD

      protected static final org.elasticsearch.common.ParseField TEXT_FIELD

    • PREFIX_FIELD

      protected static final org.elasticsearch.common.ParseField PREFIX_FIELD

    • REGEX_FIELD

      protected static final org.elasticsearch.common.ParseField REGEX_FIELD

    • FIELDNAME_FIELD

      protected static final org.elasticsearch.common.ParseField FIELDNAME_FIELD

    • ANALYZER_FIELD

      protected static final org.elasticsearch.common.ParseField ANALYZER_FIELD

    • SIZE_FIELD

      protected static final org.elasticsearch.common.ParseField SIZE_FIELD

    • SHARDSIZE_FIELD

      protected static final org.elasticsearch.common.ParseField SHARDSIZE_FIELD

  • Constructor Details

    • SuggestionBuilder

      protected SuggestionBuilder​(java.lang.String field)
      Creates a new suggestion.
      Parameters:
      field - field to execute suggestions on

    • SuggestionBuilder

      protected SuggestionBuilder​(java.lang.String field, SuggestionBuilder<?> in)
      internal copy constructor that copies over all class fields from second SuggestionBuilder except field name.

    • SuggestionBuilder

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

  • Method Details

    • writeTo

      public final 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

    • doWriteTo

      protected abstract void doWriteTo​(StreamOutput out) throws java.io.IOException
      Throws:
      java.io.IOException

    • text

      public T text​(java.lang.String text)
      Same as in SuggestBuilder.setGlobalText(String), but in the suggestion scope.

    • text

      public java.lang.String text()
      get the text for this suggestion

    • prefix

      protected T prefix​(java.lang.String prefix)

    • prefix

      public java.lang.String prefix()
      get the prefix for this suggestion

    • regex

      protected T regex​(java.lang.String regex)

    • regex

      public java.lang.String regex()
      get the regex for this suggestion

    • field

      public java.lang.String field()
      get the field() parameter

    • analyzer

      public T analyzer​(java.lang.String analyzer)
      Sets the analyzer to analyse to suggest text with. Defaults to the search analyzer of the suggest field.

    • analyzer

      public java.lang.String analyzer()
      get the analyzer() parameter

    • size

      public T size​(int size)
      Sets the maximum suggestions to be returned per suggest text term.

    • size

      public java.lang.Integer size()
      get the size() parameter

    • shardSize

      public T shardSize​(java.lang.Integer shardSize)
      Sets the maximum number of suggested term to be retrieved from each individual shard. During the reduce phase the only the top N suggestions are returned based on the size option. Defaults to the size option.

      Setting this to a value higher than the `size` can be useful in order to get a more accurate document frequency for suggested terms. Due to the fact that terms are partitioned amongst shards, the shard level document frequencies of suggestions may not be precise. Increasing this will make these document frequencies more precise.

    • shardSize

      public java.lang.Integer shardSize()
      get the shardSize() parameter

    • 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

    • innerToXContent

      protected abstract org.elasticsearch.common.xcontent.XContentBuilder innerToXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Throws:
      java.io.IOException

    • build

      protected abstract SuggestionSearchContext.SuggestionContext build​(SearchExecutionContext context) throws java.io.IOException
      Throws:
      java.io.IOException

    • populateCommonFields

      protected void populateCommonFields​(SearchExecutionContext context, SuggestionSearchContext.SuggestionContext suggestionContext)
      Transfers the text, prefix, regex, analyzer, field, size and shard size settings from the original SuggestionBuilder to the target SuggestionSearchContext.SuggestionContext

    • equals

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

    • doEquals

      protected abstract boolean doEquals​(T other)
      Indicates whether some other SuggestionBuilder of the same type is "equal to" this one.

    • hashCode

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

    • doHashCode

      protected abstract int doHashCode()
      HashCode for the subclass of SuggestionBuilder to implement.