org.elasticsearch.index.query

Class TermsQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.TermsQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<TermsQueryBuilder>

public class TermsQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<TermsQueryBuilder>

A filer for a field based on several terms matching on any of them.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
TermsQueryBuilder(String name, double... values) A filer for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, float... values) A filer for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, int... values) A filer for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, Iterable values) A filer for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, long... values) A filer for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, Object... values) A filer for a field based on several terms matching on any of them.
TermsQueryBuilder(String name, String... values) A filer for a field based on several terms matching on any of them.

Method Summary

Modifier and Type	Method and Description
TermsQueryBuilder	boost(float boost) Sets the boost for this query.
TermsQueryBuilder	disableCoord(boolean disableCoord) Deprecated. use [bool] query instead
void	doXContent(XContentBuilder builder, ToXContent.Params params)
TermsQueryBuilder	minimumShouldMatch(String minimumShouldMatch) Deprecated. use [bool] query instead
TermsQueryBuilder	queryName(String queryName) Sets the filter name for the filter that can be used when searching for matched_filters per hit.

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

toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

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 filer 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 filer 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 filer 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 filer 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 filer 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 filer 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,
                         Iterable values)

A filer for a field based on several terms matching on any of them.

Parameters:

name - The field name

values - The terms

Method Detail

minimumShouldMatch

@Deprecated
public TermsQueryBuilder minimumShouldMatch(String minimumShouldMatch)

Deprecated. use [bool] query instead

Sets the minimum number of matches across the provided terms. Defaults to 1.

disableCoord

@Deprecated
public TermsQueryBuilder disableCoord(boolean disableCoord)

Deprecated. use [bool] query instead

Disables Similarity#coord(int,int) in scoring. Defaults to false.

queryName

public TermsQueryBuilder queryName(String queryName)

Sets the filter name for the filter that can be used when searching for matched_filters per hit.

boost

public TermsQueryBuilder boost(float boost)

Description copied from interface: BoostableQueryBuilder

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>

doXContent

public void doXContent(XContentBuilder builder,
                       ToXContent.Params params)
                throws IOException

Specified by:

doXContent in class QueryBuilder

Throws:

IOException