Package org.elasticsearch.index.query

Class RankFeatureQueryBuilder

java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>
org.elasticsearch.index.query.RankFeatureQueryBuilder
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.index.query.QueryBuilder, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.index.query.QueryBuilder>, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public final class RankFeatureQueryBuilder extends org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>
Query to run on a [rank_feature] field.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RankFeatureQueryBuilder.ScoreFunction
    Scoring function for a [rank_feature] field.

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

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

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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<RankFeatureQueryBuilder,Void>
    PARSER
     

    Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

    boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

    Fields inherited from interface org.elasticsearch.index.query.Rewriteable

    MAX_REWRITE_ROUNDS

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RankFeatureQueryBuilder(String field, RankFeatureQueryBuilder.ScoreFunction scoreFunction)
     
    RankFeatureQueryBuilder(org.elasticsearch.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    doEquals(RankFeatureQueryBuilder other)
     
    protected int
    doHashCode()
     
    protected org.apache.lucene.search.Query
    doToQuery(org.elasticsearch.index.query.SearchExecutionContext context)
     
    protected void
    doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
     
    protected void
    doXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    String
    getWriteableName()
     

    Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

    addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

  • Constructor Details

    • RankFeatureQueryBuilder

      public RankFeatureQueryBuilder(String field, RankFeatureQueryBuilder.ScoreFunction scoreFunction)
      Parameters:
      field - The field name.
      scoreFunction - Scoring function for the rank_feature field.

    • RankFeatureQueryBuilder

      public RankFeatureQueryBuilder(org.elasticsearch.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • getWriteableName

      public String getWriteableName()

    • doWriteTo

      protected void doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      doWriteTo in class org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>
      Throws:
      IOException

    • doXContent

      protected void doXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      doXContent in class org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>
      Throws:
      IOException

    • doToQuery

      protected org.apache.lucene.search.Query doToQuery(org.elasticsearch.index.query.SearchExecutionContext context) throws IOException
      Specified by:
      doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>
      Throws:
      IOException

    • doEquals

      protected boolean doEquals(RankFeatureQueryBuilder other)
      Specified by:
      doEquals in class org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>

    • doHashCode

      protected int doHashCode()
      Specified by:
      doHashCode in class org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>