org.elasticsearch.index.query

Class MissingFilterBuilder

java.lang.Object

org.elasticsearch.index.query.BaseFilterBuilder

org.elasticsearch.index.query.MissingFilterBuilder

All Implemented Interfaces:

ToXContent, FilterBuilder

public class MissingFilterBuilder
extends BaseFilterBuilder

Constructs a filter that only match on documents that the field has a value in 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
MissingFilterBuilder(String name)

Method Summary

Modifier and Type	Method and Description
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
MissingFilterBuilder	existence(boolean existence) Should the missing filter include documents where the field doesn't exists in the docs.
MissingFilterBuilder	filterName(String filterName) Sets the filter name for the filter that can be used when searching for matched_filters per hit.
MissingFilterBuilder	nullValue(boolean nullValue) Should the missing filter automatically include fields with null value configured in the mappings.

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

MissingFilterBuilder

public MissingFilterBuilder(String name)

Method Detail

nullValue

public MissingFilterBuilder nullValue(boolean nullValue)

Should the missing filter automatically include fields with null value configured in the mappings. Defaults to false.

existence

public MissingFilterBuilder existence(boolean existence)

Should the missing filter include documents where the field doesn't exists in the docs. Defaults to true.

filterName

public MissingFilterBuilder filterName(String filterName)

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

doXContent

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

Specified by:

doXContent in class BaseFilterBuilder

Throws:

IOException