org.elasticsearch.index.query
Class TermsQueryBuilder

java.lang.Object
  extended by org.elasticsearch.index.query.BaseQueryBuilder
      extended by org.elasticsearch.index.query.TermsQueryBuilder
All Implemented Interfaces:
ToXContent, BoostableQueryBuilder<TermsQueryBuilder>, QueryBuilder

public class TermsQueryBuilder
extends BaseQueryBuilder
implements BoostableQueryBuilder<TermsQueryBuilder>


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.MapParams, ToXContent.Params
 
Field Summary
 
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
 
Constructor Summary
TermsQueryBuilder(String name, double... values)
          A query for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, float... values)
          A query for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, int... values)
          A query for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, long... values)
          A query for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, Object... values)
          A query for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, String... values)
          A query for a field based on several terms matching on any of them.
 
Method Summary
 TermsQueryBuilder boost(float boost)
          Sets the boost for this query.
 TermsQueryBuilder disableCoord(boolean disableCoord)
          Disables Similarity#coord(int,int) in scoring.
protected  void doXContent(XContentBuilder builder, ToXContent.Params params)
           
 TermsQueryBuilder minimumMatch(int minimumMatch)
          Sets the minimum number of matches across the provided terms.
 TermsQueryBuilder minimumShouldMatch(String minimumShouldMatch)
           
 
Methods inherited from class org.elasticsearch.index.query.BaseQueryBuilder
buildAsBytes, buildAsBytes, toString, toXContent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TermsQueryBuilder

public TermsQueryBuilder(String name,
                         String... values)
A query for a field based on several terms matching on any of them.

Parameters:
name - The field name
values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String name,
                         int... values)
A query for a field based on several terms matching on any of them.

Parameters:
name - The field name
values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String name,
                         long... values)
A query for a field based on several terms matching on any of them.

Parameters:
name - The field name
values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String name,
                         float... values)
A query for a field based on several terms matching on any of them.

Parameters:
name - The field name
values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String name,
                         double... values)
A query for a field based on several terms matching on any of them.

Parameters:
name - The field name
values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String name,
                         Object... values)
A query for a field based on several terms matching on any of them.

Parameters:
name - The field name
values - The terms
Method Detail

minimumMatch

public TermsQueryBuilder minimumMatch(int minimumMatch)
Sets the minimum number of matches across the provided terms. Defaults to 1.


minimumShouldMatch

public TermsQueryBuilder minimumShouldMatch(String minimumShouldMatch)

boost

public TermsQueryBuilder boost(float boost)
Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Specified by:
boost in interface BoostableQueryBuilder<TermsQueryBuilder>

disableCoord

public TermsQueryBuilder disableCoord(boolean disableCoord)
Disables Similarity#coord(int,int) in scoring. Defualts to false.


doXContent

protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws IOException
Specified by:
doXContent in class BaseQueryBuilder
Throws:
IOException


Copyright © 2009-2012. All Rights Reserved.