org.elasticsearch.index.query

Class BoolFilterBuilder

java.lang.Object

org.elasticsearch.index.query.BaseFilterBuilder

org.elasticsearch.index.query.BoolFilterBuilder

All Implemented Interfaces:

ToXContent, FilterBuilder

public class BoolFilterBuilder
extends BaseFilterBuilder

A filter that matches documents matching boolean combinations of other filters.

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
BoolFilterBuilder()

Method Summary

Modifier and Type	Method and Description
BoolFilterBuilder	cache(boolean cache) Should the filter be cached or not.
BoolFilterBuilder	cacheKey(String cacheKey)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
BoolFilterBuilder	filterName(String filterName) Sets the filter name for the filter that can be used when searching for matched_filters per hit.
boolean	hasClauses() Returns true iff this filter builder has at least one should, must or mustNot clause.
BoolFilterBuilder	must(FilterBuilder... filterBuilders) Adds multiple must filters.
BoolFilterBuilder	must(FilterBuilder filterBuilder) Adds a filter that must appear in the matching documents.
BoolFilterBuilder	mustNot(FilterBuilder... filterBuilders) Adds multiple must not filters.
BoolFilterBuilder	mustNot(FilterBuilder filterBuilder) Adds a filter that must not appear in the matching documents.
BoolFilterBuilder	should(FilterBuilder... filterBuilders) Adds multiple should filters.
BoolFilterBuilder	should(FilterBuilder filterBuilder) Adds a filter that should appear in the matching documents.

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

BoolFilterBuilder

public BoolFilterBuilder()

Method Detail

must

public BoolFilterBuilder must(FilterBuilder filterBuilder)

Adds a filter that must appear in the matching documents.

mustNot

public BoolFilterBuilder mustNot(FilterBuilder filterBuilder)

Adds a filter that must not appear in the matching documents.

should

public BoolFilterBuilder should(FilterBuilder filterBuilder)

Adds a filter that should appear in the matching documents. For a boolean filter with no MUST clauses one or more SHOULD clauses must match a document for the BooleanQuery to match.

must

public BoolFilterBuilder must(FilterBuilder... filterBuilders)

Adds multiple must filters.

mustNot

public BoolFilterBuilder mustNot(FilterBuilder... filterBuilders)

Adds multiple must not filters.

should

public BoolFilterBuilder should(FilterBuilder... filterBuilders)

Adds multiple should filters.

hasClauses

public boolean hasClauses()

Returns true iff this filter builder has at least one should, must or mustNot clause. Otherwise false.

filterName

public BoolFilterBuilder filterName(String filterName)

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

cache

public BoolFilterBuilder cache(boolean cache)

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

cacheKey

public BoolFilterBuilder cacheKey(String cacheKey)

doXContent

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

Specified by:

doXContent in class BaseFilterBuilder

Throws:

IOException