org.elasticsearch.index.query

Class FilteredQueryBuilder

java.lang.Object

org.elasticsearch.index.query.BaseQueryBuilder

org.elasticsearch.index.query.FilteredQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<FilteredQueryBuilder>, QueryBuilder

public class FilteredQueryBuilder
extends BaseQueryBuilder
implements BoostableQueryBuilder<FilteredQueryBuilder>

A query that applies a filter to the results of another query.

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
FilteredQueryBuilder(QueryBuilder queryBuilder, FilterBuilder filterBuilder) A query that applies a filter to the results of another query.

Method Summary

Modifier and Type	Method and Description
FilteredQueryBuilder	boost(float boost) Sets the boost for this query.
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
FilteredQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.

Methods inherited from class org.elasticsearch.index.query.BaseQueryBuilder

buildAsBytes, buildAsBytes, toString, toXContent

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredQueryBuilder

public FilteredQueryBuilder(@Nullable
                            QueryBuilder queryBuilder,
                            @Nullable
                            FilterBuilder filterBuilder)

A query that applies a filter to the results of another query.

Parameters:

queryBuilder - The query to apply the filter to (Can be null)

filterBuilder - The filter to apply on the query (Can be null)

Method Detail

boost

public FilteredQueryBuilder boost(float boost)

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Specified by:

boost in interface BoostableQueryBuilder<FilteredQueryBuilder>

queryName

public FilteredQueryBuilder queryName(String queryName)

Sets the query 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 BaseQueryBuilder

Throws:

IOException