001/*
002 * (C) Copyright 2018 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Gethin James
018 */
019package org.nuxeo.elasticsearch.aggregate;
020
021import java.util.Collection;
022
023import org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation;
024import org.nuxeo.ecm.core.api.DocumentModel;
025import org.nuxeo.ecm.platform.query.api.AggregateDefinition;
026import org.nuxeo.ecm.platform.query.api.Bucket;
027
028/**
029 * An aggregate that returns multiple buckets.
030 *
031 * @since 10.3
032 */
033public abstract class MultiBucketAggregate<B extends Bucket> extends AggregateEsBase<MultiBucketsAggregation, B> {
034
035    public MultiBucketAggregate(AggregateDefinition definition, DocumentModel searchDocument) {
036        super(definition, searchDocument);
037    }
038
039    @Override
040    public void parseAggregation(MultiBucketsAggregation aggregation) {
041        parseEsBuckets(aggregation.getBuckets());
042    }
043
044    /**
045     * Extract the buckets from the Elasticsearch response
046     */
047    public abstract void parseEsBuckets(Collection<? extends MultiBucketsAggregation.Bucket> buckets);
048
049}