ankitsultana commented on code in PR #13885: URL: https://github.com/apache/pinot/pull/13885#discussion_r1735411187
########## pinot-timeseries/pinot-timeseries-spi/src/main/java/org/apache/pinot/tsdb/spi/series/Series.java: ########## @@ -0,0 +1,113 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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.apache.pinot.tsdb.spi.series; + +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import javax.annotation.Nullable; +import org.apache.pinot.tsdb.spi.TimeBuckets; + + +/** + * Logically, a time-series is a list of pairs of time and data values, where time is stored in increasing order. + * A time-series is identified using its ID, which can be retrieved using {@link #getId()}. + * A time series typically also has a set of pairs of keys and values which are called tags or labels. + * We allow a Series to store time either via {@link TimeBuckets} or via a long array as in {@link #getTimeValues()}. + * Using {@link TimeBuckets} is ideal when your queries are working on evenly spaced time ranges. The other option + * exists to support use-cases such as "Instant Vectors" in PromQL. + * <p> + * <b>Warning:</b> The time and value arrays passed to the Series are not copied, and can be modified by anyone with + * access to them. This is by design, to make it easier to re-use buffers during time-series operations. + * </p> + */ +public class Series { Review Comment: The context is pretty clear that this is a time-series. Regardless using TimeSeries will be consistent with rest of the code so I have switched to time-series nomenclature everywhere (e.g. BaseTimeSeriesBuilder, TimeSeriesBuilderFactory, etc.). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
