org.elasticsearch.index.query.xcontent
Class TermsFilterBuilder

java.lang.Object
  extended by org.elasticsearch.index.query.xcontent.BaseFilterBuilder
      extended by org.elasticsearch.index.query.xcontent.TermsFilterBuilder
All Implemented Interfaces:
ToXContent, XContentFilterBuilder

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.MapParams, ToXContent.Params
 
Field Summary
 
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
 
Constructor Summary
TermsFilterBuilder(java.lang.String name, double... values)
          A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(java.lang.String name, float... values)
          A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(java.lang.String name, int... values)
          A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(java.lang.String name, long... values)
          A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(java.lang.String name, java.lang.Object... values)
          A filer for a field based on several terms matching on any of them.
TermsFilterBuilder(java.lang.String name, java.lang.String... values)
          A filer for a field based on several terms matching on any of them.
 
Method Summary
 TermsFilterBuilder cache(boolean cache)
          Should the filter be cached or not.
 void doXContent(XContentBuilder builder, ToXContent.Params params)
           
 TermsFilterBuilder filterName(java.lang.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.xcontent.BaseFilterBuilder
toXContent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TermsFilterBuilder

public TermsFilterBuilder(java.lang.String name,
                          java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String name,
                          java.lang.Object... 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

filterName

public TermsFilterBuilder filterName(java.lang.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.


doXContent

public void doXContent(XContentBuilder builder,
                       ToXContent.Params params)
                throws java.io.IOException
Specified by:
doXContent in class BaseFilterBuilder
Throws:
java.io.IOException