somandal commented on code in PR #9810: URL: https://github.com/apache/pinot/pull/9810#discussion_r1041468676
########## pinot-segment-local/src/main/java/org/apache/pinot/segment/local/segment/index/loader/BaseForwardIndexBasedIndexHandler.java: ########## @@ -0,0 +1,86 @@ +/** + * 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.local.segment.index.loader; + +import java.io.IOException; +import java.util.HashSet; +import java.util.Set; +import org.apache.pinot.segment.spi.ColumnMetadata; +import org.apache.pinot.segment.spi.SegmentMetadata; +import org.apache.pinot.segment.spi.creator.IndexCreatorProvider; +import org.apache.pinot.segment.spi.store.ColumnIndexType; +import org.apache.pinot.segment.spi.store.SegmentDirectory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * Base class for all of the {@link IndexHandler} classes which need to build their indexes from the forward index. + * This class handles temporarily rebuilding the forward index if the forward index does not exist and cleaning up + * the forward index once all handlers have completed via overriding the postUpdateIndicesCleanup() method. + */ +public abstract class BaseForwardIndexBasedIndexHandler implements IndexHandler { Review Comment: > Is it possible to fold this into a utility class with public static methods instead ? So I specifically wanted to implement the `postUpdateIndicesCleanup` so that not all `IndexHandler` classes need to implement this. So don't really like the idea of a utility class as I'll need to implement this method to call the utility. > Alternatively, will it make sense to call it BaseIndexHandler instead with the same purpose of extracting out common piece into it and let concrete implementations override the abstract implementation when needed ? `BaseIndexHandler` is an option. Do you suggest that all `IndexHandler` classes extend from this, and the classes that don't use the forward index to build their indexes just override the `postUpdateIndicesCleanup` to be a no-op? > Another question for future changes - going forward if someone wants to implement the IndexHandler interface, then they should extend from BaseForwardIndexBasedIndexHandler if the index generation needs fwd index otherwise directly implement IndexHandler ? Is that the expectation ? Yes that was indeed the expectation -- 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
