gortiz commented on code in PR #10191: URL: https://github.com/apache/pinot/pull/10191#discussion_r1121440698
########## pinot-segment-spi/src/main/java/org/apache/pinot/segment/spi/index/IndexType.java: ########## @@ -0,0 +1,134 @@ +/** + * 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.segment.spi.index; + +import com.fasterxml.jackson.databind.JsonNode; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.segment.spi.ColumnMetadata; +import org.apache.pinot.segment.spi.creator.IndexCreationContext; +import org.apache.pinot.segment.spi.index.column.ColumnIndexContainer; +import org.apache.pinot.segment.spi.store.SegmentDirectory; +import org.apache.pinot.spi.config.table.IndexConfig; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * TODO: implement mutable indexes. + * @param <C> the class that represents how this object is configured. + * @param <IR> the {@link IndexReader} subclass that should be used to read indexes of this type. + * @param <IC> the {@link IndexCreator} subclass that should be used to create indexes of this type. + */ +public interface IndexType<C extends IndexConfig, IR extends IndexReader, IC extends IndexCreator> { + + /** + * The unique id that identifies this index type. + * In case there is more than one implementation for a given index, then all should share the same id in order to be + * correctly registered in the {@link IndexService}. Review Comment: They are going to be added in the following PRs. If I remove them here, they will be removed when I merge these changes into the new PRs and I would need to manually recover them, which is quite error prone. Unless these links break the compilation, I would prefer to let them here -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
