Class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>>

java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<QB>
org.elasticsearch.index.query.BaseTermQueryBuilder<QB>
All Implemented Interfaces:
NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>
Direct Known Subclasses:
SpanTermQueryBuilder, TermQueryBuilder

public abstract class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>>
extends AbstractQueryBuilder<QB>
  • Field Details

    • VALUE_FIELD

      public static final org.elasticsearch.common.ParseField VALUE_FIELD
    • fieldName

      protected final java.lang.String fieldName
      Name of field to match against.
    • value

      protected final java.lang.Object value
      Value to find matches for.
  • Constructor Details

    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, java.lang.String value)
      Constructs a new base term query.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, int value)
      Constructs a new base term query.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, long value)
      Constructs a new base term query.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, float value)
      Constructs a new base term query.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, double value)
      Constructs a new base term query.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, boolean value)
      Constructs a new base term query.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      public BaseTermQueryBuilder​(java.lang.String fieldName, java.lang.Object value)
      Constructs a new base term query. In case value is assigned to a string, we internally convert it to a BytesRef because in TermQueryBuilder and SpanTermQueryBuilder string values are parsed to BytesRef and we want internal representation of query to be equal regardless of whether it was created from XContent or via Java API.
      Parameters:
      fieldName - The name of the field
      value - The value of the term
    • BaseTermQueryBuilder

      protected BaseTermQueryBuilder​(StreamInput in) throws java.io.IOException
      Read from a stream.
      Throws:
      java.io.IOException
  • Method Details

    • doWriteTo

      protected void doWriteTo​(StreamOutput out) throws java.io.IOException
      Specified by:
      doWriteTo in class AbstractQueryBuilder<QB extends BaseTermQueryBuilder<QB>>
      Throws:
      java.io.IOException
    • fieldName

      public java.lang.String fieldName()
      Returns the field name used in this query.
    • value

      public java.lang.Object value()
      Returns the value used in this query. If necessary, converts internal BytesRef representation back to string.
    • 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 AbstractQueryBuilder<QB extends BaseTermQueryBuilder<QB>>
      Throws:
      java.io.IOException
    • addExtraXContent

      protected void addExtraXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Throws:
      java.io.IOException
    • doHashCode

      protected int doHashCode()
      Specified by:
      doHashCode in class AbstractQueryBuilder<QB extends BaseTermQueryBuilder<QB>>
    • doEquals

      protected boolean doEquals​(QB other)
      Description copied from class: AbstractQueryBuilder
      Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
      Specified by:
      doEquals in class AbstractQueryBuilder<QB extends BaseTermQueryBuilder<QB>>