org.elasticsearch.index.query.BoolFilterBuilder Maven / Gradle / Ivy
/*
* Licensed to ElasticSearch and Shay Banon 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.apache.lucene.search.BooleanClause;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.ToXContent.Params;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A filter that matches documents matching boolean combinations of other filters.
*
*
*/
public class BoolFilterBuilder extends BaseFilterBuilder {
private ArrayList mustClauses = new ArrayList();
private ArrayList mustNotClauses = new ArrayList();
private ArrayList shouldClauses = new ArrayList();
private Boolean cache;
private String cacheKey;
private String filterName;
/**
* Adds a filter that must appear in the matching documents.
*/
public BoolFilterBuilder must(FilterBuilder filterBuilder) {
mustClauses.add(filterBuilder);
return this;
}
/**
* Adds a filter that must not appear in the matching documents.
*/
public BoolFilterBuilder mustNot(FilterBuilder filterBuilder) {
mustNotClauses.add(filterBuilder);
return this;
}
/**
* Adds a filter that should appear in the matching documents. For a boolean filter
* with no MUST clauses one or more SHOULD clauses must match a document
* for the BooleanQuery to match.
*/
public BoolFilterBuilder should(FilterBuilder filterBuilder) {
shouldClauses.add(filterBuilder);
return this;
}
/**
* Adds multiple must filters.
*/
public BoolFilterBuilder must(FilterBuilder... filterBuilders) {
for (FilterBuilder fb : filterBuilders) {
mustClauses.add(fb);
}
return this;
}
/**
* Adds multiple must not filters.
*/
public BoolFilterBuilder mustNot(FilterBuilder... filterBuilders) {
for (FilterBuilder fb : filterBuilders) {
mustNotClauses.add(fb);
}
return this;
}
/**
* Adds multiple should filters.
*/
public BoolFilterBuilder should(FilterBuilder... filterBuilders) {
for (FilterBuilder fb : filterBuilders) {
shouldClauses.add(fb);
}
return this;
}
/**
* Sets the filter name for the filter that can be used when searching for matched_filters per hit.
*/
public BoolFilterBuilder filterName(String filterName) {
this.filterName = filterName;
return this;
}
/**
* Should the filter be cached or not. Defaults to false.
*/
public BoolFilterBuilder cache(boolean cache) {
this.cache = cache;
return this;
}
public BoolFilterBuilder cacheKey(String cacheKey) {
this.cacheKey = cacheKey;
return this;
}
@Override
protected void doXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject("bool");
doXArrayContent("must", mustClauses, builder, params);
doXArrayContent("must_not", mustNotClauses, builder, params);
doXArrayContent("should", shouldClauses, builder, params);
if (filterName != null) {
builder.field("_name", filterName);
}
if (cache != null) {
builder.field("_cache", cache);
}
if (cacheKey != null) {
builder.field("_cache_key", cacheKey);
}
builder.endObject();
}
private void doXArrayContent(String field, List clauses, XContentBuilder builder, Params params) throws IOException {
if (clauses.isEmpty()) {
return;
}
if (clauses.size() == 1) {
builder.field(field);
clauses.get(0).toXContent(builder, params);
} else {
builder.startArray(field);
for (FilterBuilder clause : clauses) {
clause.toXContent(builder, params);
}
builder.endArray();
}
}
}