Package org.elasticsearch.index.query

Class BoostingQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<BoostingQueryBuilder>

org.elasticsearch.index.query.BoostingQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public class BoostingQueryBuilder
extends AbstractQueryBuilder<BoostingQueryBuilder>

The BoostingQuery class can be used to effectively demote results that match a given query. Unlike the "NOT" clause, this still selects documents that contain undesirable terms, but reduces their overall score:

Query balancedQuery = new BoostingQuery(positiveQuery, negativeQuery, 0.01f); In this scenario the positiveQuery contains the mandatory, desirable criteria which is used to select all matching documents, and the negativeQuery contains the undesirable elements which are simply used to lessen the scores. Documents that match the negativeQuery have their score multiplied by the supplied "boost" parameter, so this should be less than 1 to achieve a demoting effect

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BoostingQueryBuilder(StreamInput in)	Read from a stream.
BoostingQueryBuilder(QueryBuilder positiveQuery, QueryBuilder negativeQuery)	Create a new BoostingQueryBuilder

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(BoostingQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected void	extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)	For internal usage only! Extracts the inner hits from the query tree.
static BoostingQueryBuilder	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
String	getWriteableName()	Returns the name of the writeable object
float	negativeBoost()	Get the negative boost factor.
BoostingQueryBuilder	negativeBoost(float negativeBoost)	Set the negative boost factor.
QueryBuilder	negativeQuery()	Get the negative query for this boosting query.
QueryBuilder	positiveQuery()	Get the positive query for this boosting query.

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Details

BoostingQueryBuilder

public BoostingQueryBuilder(QueryBuilder positiveQuery,
 QueryBuilder negativeQuery)

Create a new BoostingQueryBuilder

Parameters:

positiveQuery - the positive query for this boosting query.

negativeQuery - the negative query for this boosting query.

BoostingQueryBuilder

public BoostingQueryBuilder(StreamInput in)
                     throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<BoostingQueryBuilder>

Throws:

IOException

positiveQuery

public QueryBuilder positiveQuery()

Get the positive query for this boosting query.

negativeQuery

public QueryBuilder negativeQuery()

Get the negative query for this boosting query.

negativeBoost

public BoostingQueryBuilder negativeBoost(float negativeBoost)

Set the negative boost factor.

negativeBoost

public float negativeBoost()

Get the negative boost factor.

doXContent

protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<BoostingQueryBuilder>

Throws:

IOException

fromXContent

public static BoostingQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                         throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<BoostingQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<BoostingQueryBuilder>

doEquals

protected boolean doEquals(BoostingQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<BoostingQueryBuilder>

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<BoostingQueryBuilder>

Throws:

IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)

Description copied from class: AbstractQueryBuilder

For internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<BoostingQueryBuilder>