uk.gov.gchq.gaffer.time.LongTimeSeries Maven / Gradle / Ivy
/*
* 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;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.google.common.collect.Sets;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import uk.gov.gchq.gaffer.commonutil.CommonTimeUtil;
import uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket;
import uk.gov.gchq.gaffer.commonutil.ToStringBuilder;
import java.time.Instant;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.DAY;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.HOUR;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.MILLISECOND;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.MINUTE;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.MONTH;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.SECOND;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.WEEK;
import static uk.gov.gchq.gaffer.commonutil.CommonTimeUtil.TimeBucket.YEAR;
/**
* This is a time series where the values are {@link Long}s. When the time series
* is created, a {@link TimeBucket} is specified. When timestamps are added, they
* are rounded to the nearest bucket, e.g. if a {@link TimeBucket} of
* MINUTE is specified, and a timestamp of January 1st 2017, 12:34:56
* is added then the seconds are removed so that the value is associated to
* 12:34.
*/
@JsonPropertyOrder(alphabetic = true)
public class LongTimeSeries implements TimeSeries {
private static final Set VALID_TIME_BUCKETS = Sets.newHashSet(
MILLISECOND,
SECOND,
MINUTE,
HOUR,
DAY,
WEEK,
MONTH,
YEAR
);
private final TimeBucket timeBucket;
private final SortedMap timeSeries = new TreeMap<>();
public LongTimeSeries(final TimeBucket timeBucket) {
if (!VALID_TIME_BUCKETS.contains(timeBucket)) {
throw new IllegalArgumentException("A TimeBucket of " + timeBucket + " is not supported");
}
this.timeBucket = timeBucket;
}
@JsonCreator
public LongTimeSeries(@JsonProperty("timeBucket") final TimeBucket timeBucket,
@JsonProperty("timeSeries") final Map timeSeries) {
this(timeBucket);
setTimeSeries(timeSeries);
}
/**
* Puts the provided value into the time series associated to
* the {@link Instant} instant. Note that this overwrites any
* previous value in that bucket.
*
* @param instant The instant at which the value was observed.
* @param value The value observed at the instant.
*/
@Override
public void put(final Instant instant, final Long value) {
final long bucket = toLong(timeBucket, instant.toEpochMilli());
timeSeries.put(bucket, value);
}
/**
* Returns the value associated to the given {@link Instant}. Note that this
* instant is rounded to the nearest time bucket.
*
* @param instant The instant that the value is required for.
* @return The value associated to the instant.
*/
@JsonIgnore
@Override
public Long get(final Instant instant) {
return timeSeries.get(toLong(timeBucket, instant.toEpochMilli()));
}
/**
* Adds the given count to the current value associated to the
* given {@link Instant}. If there is no value currently associated to the
* {@link Instant} then the count is simply inserted. Note
* that the caller of this method is responsible for dealing with the case
* where adding count would cause an overflow.
*
* @param instant The instant at which the value was observed.
* @param count The value observed at the instant.
*/
public void upsert(final Instant instant, final long count) {
final long bucket = toLong(timeBucket, instant.toEpochMilli());
timeSeries.merge(bucket, count, (x, y) -> x + y);
}
/**
* Returns a {@link SortedSet} of all the {@link Instant}s in the time series.
*
* @return A {@link SortedSet} of all the {@link Instant}s in the time series.
*/
@JsonIgnore
public SortedSet getInstants() {
final SortedSet instants = new TreeSet<>();
timeSeries
.keySet()
.stream()
.map(l -> getInstantFromLong(timeBucket, l))
.forEach(instants::add);
return instants;
}
/**
* Returns the number of instants in the time series.
*
* @return The number of instants in the time series.
*/
@JsonIgnore
public int getNumberOfInstants() {
return timeSeries.size();
}
/**
* Returns the time series as a {@link SortedMap} where the key is an
* {@link Instant} rounded to the nearest bucket and the value is the
* associated count.
*
* @return The time series.
*/
public SortedMap getTimeSeries() {
final SortedMap map = new TreeMap<>();
timeSeries.forEach((k, v) -> map.put(getInstantFromLong(timeBucket, k), v));
return map;
}
/**
* Sets the time series to be the given time series.
*
* @param timeSeries The time series to copy entries from.
*/
public void setTimeSeries(final Map timeSeries) {
if (null == timeBucket) {
throw new IllegalArgumentException("timeBucket should be configured before setting a timeSeries");
}
this.timeSeries.clear();
if (null != timeSeries) {
timeSeries.forEach(this::put);
}
}
public TimeBucket getTimeBucket() {
return timeBucket;
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (null == obj || getClass() != obj.getClass()) {
return false;
}
final LongTimeSeries that = (LongTimeSeries) obj;
return new EqualsBuilder()
.append(timeBucket, that.timeBucket)
.append(timeSeries, that.timeSeries)
.isEquals();
}
@Override
public int hashCode() {
return new HashCodeBuilder(21, 3)
.append(timeBucket)
.append(timeSeries)
.toHashCode();
}
@Override
public String toString() {
return new ToStringBuilder(this)
.append("timeBucket", timeBucket)
.append("timeSeries", timeSeries)
.build();
}
private static long toLong(final TimeBucket timeBucket, final long time) {
final long timeTruncatedToBucket = CommonTimeUtil.timeToBucket(time, timeBucket);
switch (timeBucket) {
case MILLISECOND:
return timeTruncatedToBucket;
case SECOND:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_SECOND;
case MINUTE:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_MINUTE;
case HOUR:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_HOUR;
case DAY:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_DAY;
case WEEK:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_DAY;
case MONTH:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_DAY;
case YEAR:
return timeTruncatedToBucket / CommonTimeUtil.MILLISECONDS_IN_DAY;
default:
throw new IllegalStateException("Unknown time bucket of " + timeBucket);
}
}
private static long fromLong(final TimeBucket timeBucket, final long l) {
switch (timeBucket) {
case MILLISECOND:
return l;
case SECOND:
return l * CommonTimeUtil.MILLISECONDS_IN_SECOND;
case MINUTE:
return l * CommonTimeUtil.MILLISECONDS_IN_MINUTE;
case HOUR:
return l * CommonTimeUtil.MILLISECONDS_IN_HOUR;
case DAY:
return l * CommonTimeUtil.MILLISECONDS_IN_DAY;
case WEEK:
return l * CommonTimeUtil.MILLISECONDS_IN_DAY;
case MONTH:
return l * CommonTimeUtil.MILLISECONDS_IN_DAY;
case YEAR:
return l * CommonTimeUtil.MILLISECONDS_IN_DAY;
default:
throw new IllegalStateException("Unknown time bucket of " + timeBucket);
}
}
private static Instant getInstantFromLong(final TimeBucket timeBucket, final long l) {
return Instant.ofEpochMilli(fromLong(timeBucket, l));
}
public static class Builder {
private TimeBucket timeBucket;
private Map timeSeries;
public Builder timeBucket(final TimeBucket timeBucket) {
this.timeBucket = timeBucket;
return this;
}
public Builder instantCountPairs(final Map timeSeries) {
this.timeSeries = timeSeries;
return this;
}
public LongTimeSeries build() {
return new LongTimeSeries(timeBucket, timeSeries);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy