org.elasticsearch.index.query.TermsQueryBuilder Maven / Gradle / Ivy
/*
* Licensed to Elastic Search and Shay Banon under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. Elastic Search 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 java.io.IOException;
import java.util.Collection;
/**
*
*/
public class TermsQueryBuilder extends BaseQueryBuilder implements BoostableQueryBuilder {
private final String name;
private final Object[] values;
private String minimumShouldMatch;
private Boolean disableCoord;
private float boost = -1;
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, String... values) {
this(name, (Object[]) values);
}
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, int... values) {
this.name = name;
this.values = new Integer[values.length];
for (int i = 0; i < values.length; i++) {
this.values[i] = values[i];
}
}
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, long... values) {
this.name = name;
this.values = new Long[values.length];
for (int i = 0; i < values.length; i++) {
this.values[i] = values[i];
}
}
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, float... values) {
this.name = name;
this.values = new Float[values.length];
for (int i = 0; i < values.length; i++) {
this.values[i] = values[i];
}
}
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, double... values) {
this.name = name;
this.values = new Double[values.length];
for (int i = 0; i < values.length; i++) {
this.values[i] = values[i];
}
}
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, Object... values) {
this.name = name;
this.values = values;
}
/**
* A query for a field based on several terms matching on any of them.
*
* @param name The field name
* @param values The terms
*/
public TermsQueryBuilder(String name, Collection values) {
this(name, values.toArray());
}
/**
* Sets the minimum number of matches across the provided terms. Defaults to 1.
*/
public TermsQueryBuilder minimumMatch(int minimumMatch) {
this.minimumShouldMatch = Integer.toString(minimumMatch);
return this;
}
public TermsQueryBuilder minimumShouldMatch(String minimumShouldMatch) {
this.minimumShouldMatch = minimumShouldMatch;
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.
*/
public TermsQueryBuilder boost(float boost) {
this.boost = boost;
return this;
}
/**
* Disables Similarity#coord(int,int) in scoring. Defualts to false.
*/
public TermsQueryBuilder disableCoord(boolean disableCoord) {
this.disableCoord = disableCoord;
return this;
}
@Override
protected void doXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject(TermsQueryParser.NAME);
builder.startArray(name);
for (Object value : values) {
builder.value(value);
}
builder.endArray();
if (minimumShouldMatch != null) {
builder.field("minimum_should_match", minimumShouldMatch);
}
if (disableCoord != null) {
builder.field("disable_coord", disableCoord);
}
if (boost != -1) {
builder.field("boost", boost);
}
builder.endObject();
}
}