org.elasticsearch.index.query.CustomBoostFactorQueryBuilder Maven / Gradle / Ivy
/*
* 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;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.query.functionscore.FunctionScoreQueryBuilder;
import java.io.IOException;
/**
* A query that simply applies the boost factor to another query (multiply it).
*
* @deprecated use {@link FunctionScoreQueryBuilder} instead.
*/
public class CustomBoostFactorQueryBuilder extends BaseQueryBuilder {
private final QueryBuilder queryBuilder;
private float boostFactor = -1;
/**
* A query that simply applies the boost factor to another query (multiply
* it).
*
* @param queryBuilder
* The query to apply the boost factor to.
*/
public CustomBoostFactorQueryBuilder(QueryBuilder queryBuilder) {
this.queryBuilder = queryBuilder;
}
/**
* Sets the boost factor for this query.
*/
public CustomBoostFactorQueryBuilder boostFactor(float boost) {
this.boostFactor = boost;
return this;
}
@Override
protected void doXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject(CustomBoostFactorQueryParser.NAME);
builder.field("query");
queryBuilder.toXContent(builder, params);
if (boostFactor != -1) {
builder.field("boost_factor", boostFactor);
}
builder.endObject();
}
}