org.elasticsearch.search.aggregations.bucket.filters.FiltersAggregationBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Elasticsearch - Open Source, Distributed, RESTful Search Engine
There is a newer version: 8.14.1
/*
 * 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.search.aggregations.bucket.filters;

import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.query.QueryBuilder;
import org.elasticsearch.search.aggregations.AggregationBuilder;
import org.elasticsearch.search.builder.SearchSourceBuilderException;

import java.io.IOException;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * Builder for the {@link Filters} aggregation.
 */
public class FiltersAggregationBuilder extends AggregationBuilder {

    private Map keyedFilters = null;
    private List nonKeyedFilters = null;
    private Boolean otherBucket;
    private String otherBucketKey;

    /**
     * Sole constructor.
     */
    public FiltersAggregationBuilder(String name) {
        super(name, InternalFilters.TYPE.name());
    }

    /**
     * Add a new filter with the given key.
     * NOTE: if a filter was already defined for this key, then this filter will replace it.
     * NOTE: the same {@link FiltersAggregationBuilder} cannot have both keyed and non-keyed filters
     */
    public FiltersAggregationBuilder filter(String key, QueryBuilder filter) {
        if (keyedFilters == null) {
            keyedFilters = new LinkedHashMap<>();
        }
        keyedFilters.put(key, filter);
        return this;
    }

    /**
     * Add a new filter with no key.
     * NOTE: the same {@link FiltersAggregationBuilder} cannot have both keyed and non-keyed filters.
     */
    public FiltersAggregationBuilder filter(QueryBuilder filter) {
        if (nonKeyedFilters == null) {
            nonKeyedFilters = new ArrayList<>();
        }
        nonKeyedFilters.add(filter);
        return this;
    }

    /**
     * Include a bucket for documents not matching any filter
     */
    public FiltersAggregationBuilder otherBucket(boolean otherBucket) {
        this.otherBucket = otherBucket;
        return this;
    }

    /**
     * The key to use for the bucket for documents not matching any filter. Will
     * implicitly enable the other bucket if set.
     */
    public FiltersAggregationBuilder otherBucketKey(String otherBucketKey) {
        this.otherBucketKey = otherBucketKey;
        return this;
    }

    @Override
    protected XContentBuilder internalXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        if (keyedFilters == null && nonKeyedFilters == null) {
            throw new SearchSourceBuilderException("At least one filter must be set on filter aggregation [" + getName() + "]");
        }
        if (keyedFilters != null && nonKeyedFilters != null) {
            throw new SearchSourceBuilderException("Cannot add both keyed and non-keyed filters to filters aggregation");
        }

        if (keyedFilters != null) {
            builder.startObject(FiltersParser.FILTERS_FIELD.getPreferredName());
            for (Map.Entry entry : keyedFilters.entrySet()) {
                builder.field(entry.getKey());
                entry.getValue().toXContent(builder, params);
            }
            builder.endObject();
        }
        if (nonKeyedFilters != null) {
            builder.startArray(FiltersParser.FILTERS_FIELD.getPreferredName());
            for (QueryBuilder filterBuilder : nonKeyedFilters) {
                filterBuilder.toXContent(builder, params);
            }
            builder.endArray();

        }
        if (otherBucketKey != null) {
            builder.field(FiltersParser.OTHER_BUCKET_KEY_FIELD.getPreferredName(), otherBucketKey);
        }
        if (otherBucket != null) {
            builder.field(FiltersParser.OTHER_BUCKET_FIELD.getPreferredName(), otherBucket);
        }
        return builder.endObject();
    }
}