org.elasticsearch.index.query.functionscore

Class FunctionScoreQueryBuilder

java.lang.Object

org.elasticsearch.index.query.BaseQueryBuilder

org.elasticsearch.index.query.functionscore.FunctionScoreQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<FunctionScoreQueryBuilder>, QueryBuilder

public class FunctionScoreQueryBuilder
extends BaseQueryBuilder
implements BoostableQueryBuilder<FunctionScoreQueryBuilder>

A query that uses a filters with a script associated with them to compute the score.

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
FunctionScoreQueryBuilder()
FunctionScoreQueryBuilder(FilterBuilder filterBuilder) Creates a function_score query that executes on documents that match query a query.
FunctionScoreQueryBuilder(QueryBuilder queryBuilder) Creates a function_score query that executes on documents that match query a query.
FunctionScoreQueryBuilder(QueryBuilder queryBuilder, FilterBuilder filterBuilder) Creates a function_score query that executes on documents that match query and filter.
FunctionScoreQueryBuilder(ScoreFunctionBuilder scoreFunctionBuilder) Creates a function_score query that will execute the function scoreFunctionBuilder on all documents.

Method Summary

Modifier and Type	Method and Description
FunctionScoreQueryBuilder	add(FilterBuilder filter, ScoreFunctionBuilder scoreFunctionBuilder) Adds a score function that will will execute the function scoreFunctionBuilder on all documents matching the filter.
FunctionScoreQueryBuilder	add(ScoreFunctionBuilder scoreFunctionBuilder) Adds a score function that will will execute the function scoreFunctionBuilder on all documents.
FunctionScoreQueryBuilder	boost(float boost) Sets the boost for this query.
FunctionScoreQueryBuilder	boostMode(CombineFunction combineFunction) Score mode defines how the combined result of score functions will influence the final score together with the sub query score.
FunctionScoreQueryBuilder	boostMode(String boostMode) Score mode defines how the combined result of score functions will influence the final score together with the sub query score.
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
FunctionScoreQueryBuilder	maxBoost(float maxBoost) Tha maximum boost that will be applied by function score.
FunctionScoreQueryBuilder	scoreMode(String scoreMode) Score mode defines how results of individual score functions will be aggregated.
FunctionScoreQueryBuilder	setMinScore(float minScore)

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

FunctionScoreQueryBuilder

public FunctionScoreQueryBuilder(QueryBuilder queryBuilder)

Creates a function_score query that executes on documents that match query a query. Query and filter will be wrapped into a filtered_query.

Parameters:

queryBuilder - the query that defines which documents the function_score query will be executed on.

FunctionScoreQueryBuilder

public FunctionScoreQueryBuilder(FilterBuilder filterBuilder)

Creates a function_score query that executes on documents that match query a query. Query and filter will be wrapped into a filtered_query.

Parameters:

filterBuilder - the filter that defines which documents the function_score query will be executed on.

FunctionScoreQueryBuilder

public FunctionScoreQueryBuilder(QueryBuilder queryBuilder,
                                 FilterBuilder filterBuilder)

Creates a function_score query that executes on documents that match query and filter. Query and filter will be wrapped into a filtered_query.

Parameters:

queryBuilder - a query that will; be wrapped in a filtered query.

filterBuilder - the filter for the filtered query.

FunctionScoreQueryBuilder

public FunctionScoreQueryBuilder()

FunctionScoreQueryBuilder

public FunctionScoreQueryBuilder(ScoreFunctionBuilder scoreFunctionBuilder)

Creates a function_score query that will execute the function scoreFunctionBuilder on all documents.

Parameters:

scoreFunctionBuilder - score function that is executed

Method Detail

add

public FunctionScoreQueryBuilder add(FilterBuilder filter,
                                     ScoreFunctionBuilder scoreFunctionBuilder)

Adds a score function that will will execute the function scoreFunctionBuilder on all documents matching the filter.

Parameters:

filter - the filter that defines which documents the function_score query will be executed on.

scoreFunctionBuilder - score function that is executed

add

public FunctionScoreQueryBuilder add(ScoreFunctionBuilder scoreFunctionBuilder)

Adds a score function that will will execute the function scoreFunctionBuilder on all documents.

Parameters:

scoreFunctionBuilder - score function that is executed

scoreMode

public FunctionScoreQueryBuilder scoreMode(String scoreMode)

Score mode defines how results of individual score functions will be aggregated. Can be first, avg, max, sum, min, multiply

boostMode

public FunctionScoreQueryBuilder boostMode(String boostMode)

Score mode defines how the combined result of score functions will influence the final score together with the sub query score. Can be replace, avg, max, sum, min, multiply

boostMode

public FunctionScoreQueryBuilder boostMode(CombineFunction combineFunction)

Score mode defines how the combined result of score functions will influence the final score together with the sub query score.

maxBoost

public FunctionScoreQueryBuilder maxBoost(float maxBoost)

Tha maximum boost that will be applied by function score.

boost

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

doXContent

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

Specified by:

doXContent in class BaseQueryBuilder

Throws:

IOException

setMinScore

public FunctionScoreQueryBuilder setMinScore(float minScore)