org.elasticsearch.search.aggregations.AggregationExecutionContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.16.0

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.search.aggregations;

import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.util.BytesRef;

import java.util.function.IntSupplier;
import java.util.function.LongSupplier;
import java.util.function.Supplier;

/**
 * Used to preserve contextual information during aggregation execution. It can be used by search executors and parent
 * aggregations to provide contextual information for the child aggregation during execution such as the currently executed
 * time series id or the size of the current date histogram bucket. The information provided by this class is highly contextual and
 * only valid during the {@link LeafBucketCollector#collect} call.
 */
public class AggregationExecutionContext {

    private final Supplier tsidProvider;  // TODO remove this entirely?
    private final LongSupplier timestampProvider;
    private final IntSupplier tsidOrdProvider;
    private final LeafReaderContext leafReaderContext;

    public AggregationExecutionContext(
        LeafReaderContext leafReaderContext,
        Supplier tsidProvider,
        LongSupplier timestampProvider,
        IntSupplier tsidOrdProvider
    ) {
        this.leafReaderContext = leafReaderContext;
        this.tsidProvider = tsidProvider;
        this.timestampProvider = timestampProvider;
        this.tsidOrdProvider = tsidOrdProvider;
    }

    public LeafReaderContext getLeafReaderContext() {
        return leafReaderContext;
    }

    public BytesRef getTsidHash() {
        return tsidProvider != null ? tsidProvider.get() : null;
    }

    public long getTimestamp() {
        return timestampProvider.getAsLong();
    }

    public int getTsidHashOrd() {
        if (tsidOrdProvider == null) {
            throw new IllegalArgumentException(
                "Aggregation on a time-series field is misconfigured, likely due to lack of wrapping "
                    + "a metric aggregation within a `time-series` aggregation"
            );
        }
        return tsidOrdProvider.getAsInt();
    }
}