/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.index.query.functionscore;
import org.elasticsearch.common.lucene.search.function.CombineFunction;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.query.BoostableQueryBuilder;
import org.elasticsearch.index.query.QueryBuilder;
import java.io.IOException;
import java.util.ArrayList;
/**
* A query that uses a filters with a script associated with them to compute the
* score.
*/
public class FunctionScoreQueryBuilder extends QueryBuilder implements BoostableQueryBuilder<FunctionScoreQueryBuilder> {
private final QueryBuilder queryBuilder;
private Float boost;
private Float maxBoost;
private String scoreMode;
private String boostMode;
private ArrayList<QueryBuilder> filters = new ArrayList<>();
private ArrayList<ScoreFunctionBuilder> scoreFunctions = new ArrayList<>();
private Float minScore = null;
/**
* Creates a function_score query that executes on documents that match query a query.
* Query and filter will be wrapped into a filtered_query.
*
* @param queryBuilder the query that defines which documents the function_score query will be executed on.
*/
public FunctionScoreQueryBuilder(QueryBuilder queryBuilder) {
this.queryBuilder = queryBuilder;
}
public FunctionScoreQueryBuilder() {
this.queryBuilder = null;
}
/**
* Creates a function_score query that will execute the function scoreFunctionBuilder on all documents.
*
* @param scoreFunctionBuilder score function that is executed
*/
public FunctionScoreQueryBuilder(ScoreFunctionBuilder scoreFunctionBuilder) {
if (scoreFunctionBuilder == null) {
throw new IllegalArgumentException("function_score: function must not be null");
}
queryBuilder = null;
this.filters.add(null);
this.scoreFunctions.add(scoreFunctionBuilder);
}
/**
* Adds a score function that will will execute the function scoreFunctionBuilder on all documents matching the filter.
*
* @param filter the filter that defines which documents the function_score query will be executed on.
* @param scoreFunctionBuilder score function that is executed
*/
public FunctionScoreQueryBuilder add(QueryBuilder filter, ScoreFunctionBuilder scoreFunctionBuilder) {
if (scoreFunctionBuilder == null) {
throw new IllegalArgumentException("function_score: function must not be null");
}
this.filters.add(filter);
this.scoreFunctions.add(scoreFunctionBuilder);
return this;
}
/**
* Adds a score function that will will execute the function scoreFunctionBuilder on all documents.
*
* @param scoreFunctionBuilder score function that is executed
*/
public FunctionScoreQueryBuilder add(ScoreFunctionBuilder scoreFunctionBuilder) {
if (scoreFunctionBuilder == null) {
throw new IllegalArgumentException("function_score: function must not be null");
}
this.filters.add(null);
this.scoreFunctions.add(scoreFunctionBuilder);
return this;
}
/**
* Score mode defines how results of individual score functions will be aggregated.
* Can be first, avg, max, sum, min, multiply
*/
public FunctionScoreQueryBuilder scoreMode(String scoreMode) {
this.scoreMode = scoreMode;
return this;
}
/**
* 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
*/
public FunctionScoreQueryBuilder boostMode(String boostMode) {
this.boostMode = boostMode;
return this;
}
/**
* Score mode defines how the combined result of score functions will influence the final score together with the sub query score.
*/
public FunctionScoreQueryBuilder boostMode(CombineFunction combineFunction) {
this.boostMode = combineFunction.getName();
return this;
}
/**
* Tha maximum boost that will be applied by function score.
*/
public FunctionScoreQueryBuilder maxBoost(float maxBoost) {
this.maxBoost = maxBoost;
return this;
}
/**
* 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.
*/
@Override
public FunctionScoreQueryBuilder boost(float boost) {
this.boost = boost;
return this;
}
@Override
protected void doXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject(FunctionScoreQueryParser.NAME);
if (queryBuilder != null) {
builder.field("query");
queryBuilder.toXContent(builder, params);
}
builder.startArray("functions");
for (int i = 0; i < filters.size(); i++) {
builder.startObject();
if (filters.get(i) != null) {
builder.field("filter");
filters.get(i).toXContent(builder, params);
}
scoreFunctions.get(i).toXContent(builder, params);
builder.endObject();
}
builder.endArray();
if (scoreMode != null) {
builder.field("score_mode", scoreMode);
}
if (boostMode != null) {
builder.field("boost_mode", boostMode);
}
if (maxBoost != null) {
builder.field("max_boost", maxBoost);
}
if (boost != null) {
builder.field("boost", boost);
}
if (minScore != null) {
builder.field("min_score", minScore);
}
builder.endObject();
}
public FunctionScoreQueryBuilder setMinScore(float minScore) {
this.minScore = minScore;
return this;
}
}