uk.gov.gchq.gaffer.time.binaryoperator.LongTimeSeriesAggregator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of time-library Show documentation

There is a newer version: 2.3.1

/*
 * Copyright 2017-2020 Crown Copyright
 *
 * Licensed 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 uk.gov.gchq.gaffer.time.binaryoperator;

import uk.gov.gchq.gaffer.time.LongTimeSeries;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;
import uk.gov.gchq.koryphe.binaryoperator.KorypheBinaryOperator;

import java.time.Instant;
import java.util.Map;

/**
 * A {@code LongTimeSeriesAggregator} is a {@link java.util.function.BinaryOperator}
 * that takes in {@link LongTimeSeries}s and aggregates the time series. If both
 * time series contain a value for the same timestamp then the two timestamps
 * are summed.
 */
@Since("1.1.0")
@Summary("Aggregates LongTimeSeries objects")
public class LongTimeSeriesAggregator extends KorypheBinaryOperator {

    @Override
    protected LongTimeSeries _apply(final LongTimeSeries a, final LongTimeSeries b) {
        if (!b.getTimeBucket().equals(a.getTimeBucket())) {
            throw new RuntimeException("Can't aggregate two LongTimeSeries with different time buckets: "
                    + "a had bucket " + a.getTimeBucket() + ", b had bucket " + b.getTimeBucket());
        }
        for (final Map.Entry entry : b.getTimeSeries().entrySet()) {
            a.upsert(entry.getKey(), entry.getValue());
        }
        return a;
    }
}