Abyss-lord commented on code in PR #7200: URL: https://github.com/apache/gravitino/pull/7200#discussion_r2115245746
########## core/src/main/java/org/apache/gravitino/cache/BaseEntityCache.java: ########## @@ -0,0 +1,166 @@ +/* + * 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.gravitino.cache; + +import com.google.common.base.Preconditions; +import java.util.Collections; +import java.util.EnumMap; +import java.util.List; +import java.util.Map; +import org.apache.gravitino.Config; +import org.apache.gravitino.Entity; +import org.apache.gravitino.EntityStore; +import org.apache.gravitino.HasIdentifier; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.meta.BaseMetalake; +import org.apache.gravitino.meta.CatalogEntity; +import org.apache.gravitino.meta.ColumnEntity; +import org.apache.gravitino.meta.FilesetEntity; +import org.apache.gravitino.meta.ModelEntity; +import org.apache.gravitino.meta.ModelVersionEntity; +import org.apache.gravitino.meta.RoleEntity; +import org.apache.gravitino.meta.SchemaEntity; +import org.apache.gravitino.meta.TableEntity; +import org.apache.gravitino.meta.TagEntity; +import org.apache.gravitino.meta.TopicEntity; +import org.apache.gravitino.meta.UserEntity; +import org.apache.gravitino.storage.relational.RelationalEntityStore; + +/** + * An abstract class that provides a basic implementation for the MetaCache interface. This class is + * abstract and cannot be instantiated directly, it is designed to be a base class for other meta + * cache implementations. + * + * <p>The purpose of the BaseMetaCache is to provide a unified way of accessing entity stores, + * allowing subclasses to focus on caching logic without having to deal with entity store + * management. + */ +public abstract class BaseEntityCache implements EntityCache { + private static final Map<Entity.EntityType, Class<?>> ENTITY_CLASS_MAP; + // The entity store used by the cache, initialized through the constructor. + protected final RelationalEntityStore entityStore; + protected final Config cacheConfig; + + static { + Map<Entity.EntityType, Class<?>> map = new EnumMap<>(Entity.EntityType.class); + map.put(Entity.EntityType.METALAKE, BaseMetalake.class); + map.put(Entity.EntityType.CATALOG, CatalogEntity.class); + map.put(Entity.EntityType.SCHEMA, SchemaEntity.class); + map.put(Entity.EntityType.TABLE, TableEntity.class); + map.put(Entity.EntityType.FILESET, FilesetEntity.class); + map.put(Entity.EntityType.MODEL, ModelEntity.class); + map.put(Entity.EntityType.TOPIC, TopicEntity.class); + map.put(Entity.EntityType.TAG, TagEntity.class); + map.put(Entity.EntityType.MODEL_VERSION, ModelVersionEntity.class); + map.put(Entity.EntityType.COLUMN, ColumnEntity.class); + map.put(Entity.EntityType.USER, UserEntity.class); + map.put(Entity.EntityType.GROUP, Entity.class); + map.put(Entity.EntityType.ROLE, RoleEntity.class); + ENTITY_CLASS_MAP = Collections.unmodifiableMap(map); + } + + /** + * Constructs a new {@link BaseEntityCache} instance. If the provided entityStore is null, it will + * use the entity store configured in the Gravitino environment. + * + * @param entityStore The entity store to be used by the cache, can be null. + */ + public BaseEntityCache(Config config, EntityStore entityStore) { + this.cacheConfig = config; + this.entityStore = (RelationalEntityStore) entityStore; + } + + /** + * Returns the class of the entity based on its type. + * + * @param type The entity type + * @return The class of the entity + * @throws IllegalArgumentException if the entity type is not supported + */ + @SuppressWarnings("unchecked") + public static <E extends Entity & HasIdentifier> Class<E> getEntityClass(Entity.EntityType type) { + Preconditions.checkArgument(type != null, "EntityType must not be null"); + + Class<?> clazz = ENTITY_CLASS_MAP.get(type); + if (clazz == null) { + throw new IllegalArgumentException("Unsupported EntityType: " + type.getShortName()); + } + + return (Class<E>) clazz; + } + + /** + * Returns the {@link NameIdentifier} of the entity based on its type. + * + * @param entity The entity + * @return The {@link NameIdentifier} of the entity + */ + protected static NameIdentifier getIdentFromEntity(Entity entity) { + validateEntityHasIdentifier(entity); + HasIdentifier hasIdentifier = (HasIdentifier) entity; + + return hasIdentifier.nameIdentifier(); + } + + /** + * Checks if the entity is of type {@link HasIdentifier}. + * + * @param entity The entity to check. + */ + protected static void validateEntityHasIdentifier(Entity entity) { + Preconditions.checkArgument( + entity instanceof HasIdentifier, "Unsupported EntityType: " + entity.type()); + } + + /** + * Converts a list of entities to a new list. + * + * @param entities Thr original list of entities. + * @return A list of converted entities. + * @param <E> The type of the entities in the list. + */ + @SuppressWarnings("unchecked") + protected static <E extends Entity & HasIdentifier> List<E> convertEntity(List<Entity> entities) { Review Comment: @jerryshao Thanks for pointing that out! I just measured the line and it’s 98 characters long, so it's still within the 100-character limit. Let me know if you’d prefer it wrapped anyway for readability. -- 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]
