jerryshao commented on code in PR #7181: URL: https://github.com/apache/gravitino/pull/7181#discussion_r2101483918
########## core/src/main/java/org/apache/gravitino/cache/RelationEntityCache.java: ########## @@ -0,0 +1,109 @@ +/* + * 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 java.io.IOException; +import java.util.List; +import java.util.Optional; +import org.apache.gravitino.Entity; +import org.apache.gravitino.EntityStore; +import org.apache.gravitino.HasIdentifier; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.SupportsRelationOperations; + +/** {@code RelationEntityCache} defines caching behavior for entity-to-entity relationships. */ +public interface RelationEntityCache { + /** + * Retrieves a list of entities related to the specified entity under the given relation type. If + * the related entities are not present in the cache, they will be loaded from the underlying + * {@link EntityStore}. + * + * @param ident The name identifier of the entity to find related entities for + * @param type The type of the entity to find related entities for + * @param relType The relation type to find related entities for + * @return A list of related entities, or an empty list if none are found + * @param <E> The class of the related entities + */ + <E extends Entity & HasIdentifier> List<E> getOrLoad( + NameIdentifier ident, Entity.EntityType type, SupportsRelationOperations.Type relType) + throws IOException; + + /** + * Retrieves a list of related entities from the cache, if present. + * + * @param relType the relation type + * @param nameIdentifier the name identifier of the entity to find related entities for + * @param identType the identifier type of the related entities to find + * @return a list of related entities, or an empty list if none are found + * @param <E> The class of the related entities + */ + <E extends Entity & HasIdentifier> Optional<List<E>> getIfPresent( + SupportsRelationOperations.Type relType, + NameIdentifier nameIdentifier, + Entity.EntityType identType); + + /** + * Invalidates the cached relation for the given entity and relation type. + * + * @param ident the name identifier + * @param type the entity type + * @param relType the relation type + * @return true if the cache entry was removed + */ + boolean invalidate( + NameIdentifier ident, Entity.EntityType type, SupportsRelationOperations.Type relType); + + /** + * Checks whether an entity with the given name identifier, type, and relation type is present in + * the cache. + * + * @param ident the name identifier of the entity + * @param type the type of the entity + * @param relType the relation type + * @return {@code true} if the entity is cached; {@code false} otherwise + */ + boolean contains( + NameIdentifier ident, Entity.EntityType type, SupportsRelationOperations.Type relType); + + /** + * Puts a relation between two entities into the cache. + * + * @param srcEntity The source entity + * @param destEntity The destination entity + * @param relType The relation type + * @param <E> The class of the entities + */ + <E extends Entity & HasIdentifier> void put( + E srcEntity, E destEntity, SupportsRelationOperations.Type relType); + + /** + * Returns the current number of entries stored in the relation cache. + * + * @return the estimated size of the relation cache + */ + long sizeOfRelations(); + + /** + * Clear the cache based on the given entity. + * + * @param entity the entity to clear the cache for + */ + void clearRelations(Entity entity); Review Comment: Can we have a better name for these two interfaces -- 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]
