org.elasticsearch.index.query

Class BoolQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.BoolQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<BoolQueryBuilder>

public class BoolQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<BoolQueryBuilder>

A Query that matches documents matching boolean combinations of other queries.

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

Method Summary

Methods

Modifier and Type	Method and Description
BoolQueryBuilder	adjustPureNegative(boolean adjustPureNegative) If a boolean query contains only negative ("must not") clauses should the BooleanQuery be enhanced with a MatchAllDocsQuery in order to act as a pure exclude.
BoolQueryBuilder	boost(float boost) Sets the boost for this query.
BoolQueryBuilder	disableCoord(boolean disableCoord) Disables Similarity#coord(int,int) in scoring.
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
BoolQueryBuilder	filter(QueryBuilder queryBuilder) Adds a query that must appear in the matching documents but will not contribute to scoring.
boolean	hasClauses() Returns true iff this query builder has at least one should, must, must not or filter clause.
BoolQueryBuilder	minimumNumberShouldMatch(int minimumNumberShouldMatch) Specifies a minimum number of the optional (should) boolean clauses which must be satisfied.
BoolQueryBuilder	minimumShouldMatch(String minimumShouldMatch) Sets the minimum should match using the special syntax (for example, supporting percentage).
BoolQueryBuilder	must(QueryBuilder queryBuilder) Adds a query that must appear in the matching documents and will contribute to scoring.
BoolQueryBuilder	mustNot(QueryBuilder queryBuilder) Adds a query that must not appear in the matching documents and will not contribute to scoring.
BoolQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.
BoolQueryBuilder	should(QueryBuilder queryBuilder) Adds a query that should appear in the matching documents.

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

toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BoolQueryBuilder

public BoolQueryBuilder()

Method Detail

must

public BoolQueryBuilder must(QueryBuilder queryBuilder)

Adds a query that must appear in the matching documents and will contribute to scoring.

filter

public BoolQueryBuilder filter(QueryBuilder queryBuilder)

Adds a query that must appear in the matching documents but will not contribute to scoring.

mustNot

public BoolQueryBuilder mustNot(QueryBuilder queryBuilder)

Adds a query that must not appear in the matching documents and will not contribute to scoring.

should

public BoolQueryBuilder should(QueryBuilder queryBuilder)

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

See Also:

minimumNumberShouldMatch(int)

boost

public BoolQueryBuilder 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<BoolQueryBuilder>

disableCoord

public BoolQueryBuilder disableCoord(boolean disableCoord)

Disables Similarity#coord(int,int) in scoring. Defaults to false.

minimumNumberShouldMatch

public BoolQueryBuilder minimumNumberShouldMatch(int minimumNumberShouldMatch)

Specifies a minimum number of the optional (should) boolean clauses which must be satisfied.

By default no optional clauses are necessary for a match (unless there are no required clauses). If this method is used, then the specified number of clauses is required.

Use of this method is totally independent of specifying that any specific clauses are required (or prohibited). This number will only be compared against the number of matching optional clauses.

Parameters:

minimumNumberShouldMatch - the number of optional clauses that must match

minimumShouldMatch

public BoolQueryBuilder minimumShouldMatch(String minimumShouldMatch)

Sets the minimum should match using the special syntax (for example, supporting percentage).

hasClauses

public boolean hasClauses()

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

adjustPureNegative

public BoolQueryBuilder adjustPureNegative(boolean adjustPureNegative)

If a boolean query contains only negative ("must not") clauses should the BooleanQuery be enhanced with a MatchAllDocsQuery in order to act as a pure exclude. The default is true.

queryName

public BoolQueryBuilder 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 QueryBuilder

Throws:

IOException