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.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.index.query.QueryBuilder, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.index.query.QueryBuilder>

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.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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>
  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.lang.String NAME  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<RankFeatureQueryBuilder,​java.lang.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.common.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor Description
    RankFeatureQueryBuilder​(java.lang.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.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    java.lang.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.common.xcontent.ToXContentObject

    isFragment
  • Field Details

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<RankFeatureQueryBuilder,​java.lang.Void> PARSER
    • NAME

      public static final java.lang.String NAME
      See Also:
      Constant Field Values
  • Constructor Details

    • RankFeatureQueryBuilder

      public RankFeatureQueryBuilder​(java.lang.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 java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • getWriteableName

      public java.lang.String getWriteableName()
    • doWriteTo

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

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

      protected org.apache.lucene.search.Query doToQuery​(org.elasticsearch.index.query.SearchExecutionContext context) throws java.io.IOException
      Specified by:
      doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<RankFeatureQueryBuilder>
      Throws:
      java.io.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>