org.elasticsearch.index.query
Class TermFilterBuilder

java.lang.Object
  org.elasticsearch.index.query.BaseFilterBuilder
      org.elasticsearch.index.query.TermFilterBuilder

All Implemented Interfaces:

ToXContent, FilterBuilder

public class TermFilterBuilder
extends BaseFilterBuilder

A filter for a field based on a term.

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

TermFilterBuilder(String name, double value)
A filter for a field based on a term.

TermFilterBuilder(String name, float value)
A filter for a field based on a term.

TermFilterBuilder(String name, int value)
A filter for a field based on a term.

TermFilterBuilder(String name, long value)
A filter for a field based on a term.

TermFilterBuilder(String name, Object value)
A filter for a field based on a term.

TermFilterBuilder(String name, String value)
A filter for a field based on a term.

Method Summary

TermFilterBuilder	cache(boolean cache) Should the filter be cached or not.
TermFilterBuilder	cacheKey(String cacheKey)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
TermFilterBuilder	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

toXContent

Methods inherited from class java.lang.Object

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

Constructor Detail

TermFilterBuilder

public TermFilterBuilder(String name,
                         String value)

A filter for a field based on a term.

Parameters:

name - The field name

value - The term value

TermFilterBuilder

public TermFilterBuilder(String name,
                         int value)

A filter for a field based on a term.

Parameters:

name - The field name

value - The term value

TermFilterBuilder

public TermFilterBuilder(String name,
                         long value)

A filter for a field based on a term.

Parameters:

name - The field name

value - The term value

TermFilterBuilder

public TermFilterBuilder(String name,
                         float value)

A filter for a field based on a term.

Parameters:

name - The field name

value - The term value

TermFilterBuilder

public TermFilterBuilder(String name,
                         double value)

A filter for a field based on a term.

Parameters:

name - The field name

value - The term value

TermFilterBuilder

public TermFilterBuilder(String name,
                         Object value)

A filter for a field based on a term.

Parameters:

name - The field name

value - The term value

Method Detail

filterName

public TermFilterBuilder filterName(String filterName)

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

cache

public TermFilterBuilder cache(boolean cache)

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

cacheKey

public TermFilterBuilder cacheKey(String cacheKey)

doXContent

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

Specified by:

doXContent in class BaseFilterBuilder

Throws:

IOException