org.elasticsearch.index.query

Class TermsFilterBuilder

java.lang.Object

org.elasticsearch.index.query.BaseFilterBuilder

org.elasticsearch.index.query.TermsFilterBuilder

All Implemented Interfaces:

ToXContent, FilterBuilder

public class TermsFilterBuilder
extends BaseFilterBuilder

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
TermsFilterBuilder(String name, double... values) A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(String name, float... values) A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(String name, int... values) A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(String name, Iterable values) A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(String name, long... values) A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(String name, Object... values) A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(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
TermsFilterBuilder	cache(boolean cache) Should the filter be cached or not.
TermsFilterBuilder	cacheKey(String cacheKey)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
TermsFilterBuilder	execution(String execution) Sets the execution mode for the terms filter.
TermsFilterBuilder	filterName(String filterName) 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.BaseFilterBuilder

buildAsBytes, buildAsBytes, toString, toXContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TermsFilterBuilder

public TermsFilterBuilder(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

TermsFilterBuilder

public TermsFilterBuilder(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

TermsFilterBuilder

public TermsFilterBuilder(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

TermsFilterBuilder

public TermsFilterBuilder(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

TermsFilterBuilder

public TermsFilterBuilder(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

TermsFilterBuilder

public TermsFilterBuilder(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

TermsFilterBuilder

public TermsFilterBuilder(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

execution

public TermsFilterBuilder execution(String execution)

Sets the execution mode for the terms filter. Cane be either "plain", "bool" "and". Defaults to "plain".

filterName

public TermsFilterBuilder filterName(String filterName)

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

cache

public TermsFilterBuilder cache(boolean cache)

Should the filter be cached or not. Defaults to false.

cacheKey

public TermsFilterBuilder cacheKey(String cacheKey)

doXContent

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

Specified by:

doXContent in class BaseFilterBuilder

Throws:

IOException