get only the selected current limits when getCurrentLimits

Signed-off-by: Etienne LESOT <[email protected]>

Author: EtienneLt

network-store-client/src/main/java/com/powsybl/network/store/client/PreloadingNetworkStoreClient.java

@@ -889,4 +889,10 @@ public Optional<OperationalLimitsGroupAttributes> getOperationalLimitsGroupAttri
         delegate.getAllOperationalLimitsGroupAttributesByResourceType(networkUuid, variantNum, resourceType);
         return delegate.getOperationalLimitsGroupAttributes(networkUuid, variantNum, resourceType, branchId, operationalLimitGroupId, side);
     }
+
+    @Override
+    public Optional<OperationalLimitsGroupAttributes> getCurrentLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String branchId, String operationalLimitGroupId, int side) {
+        delegate.getSelectedCurrentLimitsGroupAttributesByResourceType(networkUuid, variantNum, resourceType);
+        return delegate.getOperationalLimitsGroupAttributes(networkUuid, variantNum, resourceType, branchId, operationalLimitGroupId, side);
+    }
 }

network-store-client/src/main/java/com/powsybl/network/store/client/RestNetworkStoreClient.java

@@ -987,4 +987,16 @@ public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupA
         return getOperationalLimitsGroupAttributesNestedMap("/networks/{networkUuid}/{variantNum}/branch/types/{resourceType}/operationalLimitsGroup/",
             networkUuid, variantNum, resourceType);
     }
+
+    @Override
+    public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getSelectedCurrentLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType resourceType) {
+        return getOperationalLimitsGroupAttributesNestedMap("/networks/{networkUuid}/{variantNum}/branch/types/{resourceType}/operationalLimitsGroup/currentLimits/",
+            networkUuid, variantNum, resourceType);
+    }
+
+    @Override
+    public Optional<OperationalLimitsGroupAttributes> getCurrentLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String branchId, String operationalLimitsGroupId, int side) {
+        return getOperationalLimitsGroupAttributes("/networks/{networkUuid}/{variantNum}/branch/{branchId}/types/{resourceType}/operationalLimitsGroup/currentLimits/{operationalLimitsGroupId}/side/{side}",
+            networkUuid, variantNum, branchId, resourceType, operationalLimitsGroupId, side);
+    }
 }

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/AbstractBranchImpl.java

@@ -303,7 +303,7 @@ public Optional<CurrentLimits> getCurrentLimits(TwoSides side) {
 
     @Override
     public CurrentLimits getNullableCurrentLimits1() {
-        loadOperationalLimitsGroup(TwoSides.ONE);
+        loadCurrentLimitsGroup(TwoSides.ONE);
         var group = getResource().getAttributes().getSelectedOperationalLimitsGroup1();
         return group != null && group.getCurrentLimits() != null
                 ? new CurrentLimitsImpl<>(this, TwoSides.ONE, group.getId(), group.getCurrentLimits())
@@ -317,7 +317,7 @@ public Optional<CurrentLimits> getCurrentLimits1() {
 
     @Override
     public CurrentLimits getNullableCurrentLimits2() {
-        loadOperationalLimitsGroup(TwoSides.TWO);
+        loadCurrentLimitsGroup(TwoSides.TWO);
         var group = getResource().getAttributes().getSelectedOperationalLimitsGroup2();
         return group != null && group.getCurrentLimits() != null
                 ? new CurrentLimitsImpl<>(this, TwoSides.TWO, group.getId(), group.getCurrentLimits())
@@ -631,4 +631,18 @@ private void loadOperationalLimitsGroup(TwoSides side) {
             index.loadOperationalLimitsGroupAttributes(ResourceType.convert(getType()), getId(), groupId, side.getNum());
         }
     }
+
+    private void loadCurrentLimitsGroup(TwoSides side) {
+        String groupId;
+        if (side == TwoSides.ONE) {
+            groupId = getResource().getAttributes().getSelectedOperationalLimitsGroupId1();
+        } else if (side == TwoSides.TWO) {
+            groupId = getResource().getAttributes().getSelectedOperationalLimitsGroupId2();
+        } else {
+            throw new PowsyblException("can not load limits on branch for a side null");
+        }
+        if (groupId != null) {
+            index.loadCurrentLimitsGroupAttributes(ResourceType.convert(getType()), getId(), groupId, side.getNum());
+        }
+    }
 }

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/CachedNetworkStoreClient.java

@@ -1101,7 +1101,6 @@ public void removeExtensionAttributes(UUID networkUuid, int variantNum, Resource
     }
 
     // limits
-
     @Override
     public Optional<OperationalLimitsGroupAttributes> getOperationalLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String identifiableId, String operationalLimitGroupName, int side) {
         return getCache(resourceType).getCollection(networkUuid, variantNum).getOperationalLimitsAttributes(networkUuid, variantNum, resourceType, identifiableId, operationalLimitGroupName, side);
@@ -1118,6 +1117,16 @@ public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupA
         return getCache(resourceType).getCollection(networkUuid, variantNum).getAllOperationalLimitsGroupAttributesByResourceType(networkUuid, variantNum, resourceType);
     }
 
+    @Override
+    public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getSelectedCurrentLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType resourceType) {
+        return getCache(resourceType).getCollection(networkUuid, variantNum).getSelectedCurrentLimitsGroupAttributesByResourceType(networkUuid, variantNum, resourceType);
+    }
+
+    @Override
+    public Optional<OperationalLimitsGroupAttributes> getCurrentLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String identifiableId, String operationalLimitGroupName, int side) {
+        return getCache(resourceType).getCollection(networkUuid, variantNum).getCurrentLimitsAttributes(networkUuid, variantNum, resourceType, identifiableId, operationalLimitGroupName, side);
+    }
+
     private NetworkCollectionIndex<? extends CollectionCache<?>> getCache(ResourceType resourceType) {
         return switch (resourceType) {
             case NETWORK -> networksCache;

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/CollectionCache.java

@@ -84,11 +84,18 @@ public class CollectionCache<T extends IdentifiableAttributes> {
      */
     private boolean isFullyLoadedOperationalLimitsGroup = false;
 
+    private boolean isFullyLoadedCurrentLimitsGroup = false;
+
     /**
      * Indicates if all the operational limits groups for a specific identifiable has been fully loaded and synchronized with the server.
      */
     private final Set<String> fullyLoadedOperationalLimitsGroupsByBranchIds = new HashSet<>();
 
+    /**
+     * Indicates if all the operational limits groups for a specific identifiable has been fully loaded and synchronized with the server.
+     */
+    private final Set<String> fullyLoadedCurrentLimitsGroupsByBranchIds = new HashSet<>();
+
     /**
      * Map storing sets of removed operational limits names associated with identifiable IDs.
      * The map is organized where:
@@ -383,6 +390,7 @@ public CollectionCache<T> clone(ObjectMapper objectMapper, int newVariantNum, Co
         clonedCache.removedOperationalLimitsGroupsAttributes.addAll(removedOperationalLimitsGroupsAttributes);
         clonedCache.fullyLoadedOperationalLimitsGroupsByBranchIds.addAll(fullyLoadedOperationalLimitsGroupsByBranchIds);
         clonedCache.isFullyLoadedOperationalLimitsGroup = isFullyLoadedOperationalLimitsGroup;
+        clonedCache.isFullyLoadedCurrentLimitsGroup = isFullyLoadedCurrentLimitsGroup;
 
         clonedCache.containerFullyLoaded.addAll(containerFullyLoaded);
         clonedCache.removedResources.addAll(removedResources);
@@ -581,6 +589,10 @@ private boolean isOperationalLimitsGroupAttributesCached(String branchId) {
         return (fullyLoadedOperationalLimitsGroupsByBranchIds.contains(branchId) || isFullyLoadedOperationalLimitsGroup) && resources.containsKey(branchId);
     }
 
+    private boolean isCurrentLimitsGroupAttributesCached(String branchId) {
+        return (fullyLoadedOperationalLimitsGroupsByBranchIds.contains(branchId) || fullyLoadedCurrentLimitsGroupsByBranchIds.contains(branchId) || isFullyLoadedOperationalLimitsGroup || isFullyLoadedCurrentLimitsGroup) && resources.containsKey(branchId);
+    }
+
     private boolean isFullyLoadedOperationalLimitsGroup(String branchId) {
         return isFullyLoadedOperationalLimitsGroup || fullyLoadedOperationalLimitsGroupsByBranchIds.contains(branchId);
     }
@@ -600,6 +612,7 @@ private void addOperationalLimitsGroupAttributesToCache(String branchId, String
         getCachedOperationalLimitsGroupAttributes(branchId, side).putIfAbsent(operationalLimitsGroupName, operationalLimitsGroupAttributes);
         OperationalLimitsGroupIdentifier identifier = OperationalLimitsGroupIdentifier.of(branchId, operationalLimitsGroupName, side);
         removedOperationalLimitsGroupsAttributes.remove(identifier);
+        fullyLoadedOperationalLimitsGroupsByBranchIds.add(branchId);
     }
 
     public void removeOperationalLimitsGroupAttributesByName(String branchId, String operationalLimitsGroupName, int side) {
@@ -628,6 +641,47 @@ public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupA
         return Collections.emptyMap();
     }
 
+    /**
+     * Get all the operational limits group attributes for all the identifiables with specified resource type in the cache
+     */
+    public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getSelectedCurrentLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType type) {
+        if (!isFullyLoadedCurrentLimitsGroup) {
+            // if collection has not yet been fully loaded we load it from the server
+            Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> operationalLimitsGroupAttributesMap =
+                delegate.getSelectedCurrentLimitsGroupAttributesByResourceType(networkUuid, variantNum, type);
+
+            // we update the full cache and set it as fully loaded
+            operationalLimitsGroupAttributesMap.forEach(this::addAllOperationalLimitsGroupAttributesToCache);
+            isFullyLoadedCurrentLimitsGroup = true;
+        }
+        return Collections.emptyMap();
+    }
+
+    public Optional<OperationalLimitsGroupAttributes> getCurrentLimitsAttributes(UUID networkUuid, int variantNum, ResourceType type,
+                                                                                     String branchId, String operationalLimitGroupName, int side) {
+        Objects.requireNonNull(branchId);
+        if (isCurrentLimitsGroupAttributesCached(branchId)) {
+            return Optional.ofNullable(getCachedOperationalLimitsGroupAttributes(branchId, side).get(operationalLimitGroupName));
+        }
+
+        if (!isFullyLoadedOperationalLimitsGroup(branchId) && !isRemovedOperationalLimitsGroupAttributes(branchId, operationalLimitGroupName, side)) {
+            return delegate.getCurrentLimitsGroupAttributes(networkUuid, variantNum, type, branchId, operationalLimitGroupName, side)
+                .map(attributes -> {
+                    addCurrentLimitsGroupAttributesToCache(branchId, operationalLimitGroupName, side, attributes);
+                    return attributes;
+                });
+        }
+        return Optional.empty();
+    }
+
+    private void addCurrentLimitsGroupAttributesToCache(String branchId, String operationalLimitsGroupName, int side, OperationalLimitsGroupAttributes operationalLimitsGroupAttributes) {
+        Objects.requireNonNull(operationalLimitsGroupAttributes);
+        getCachedOperationalLimitsGroupAttributes(branchId, side).putIfAbsent(operationalLimitsGroupName, operationalLimitsGroupAttributes);
+        OperationalLimitsGroupIdentifier identifier = OperationalLimitsGroupIdentifier.of(branchId, operationalLimitsGroupName, side);
+        removedOperationalLimitsGroupsAttributes.remove(identifier);
+        fullyLoadedCurrentLimitsGroupsByBranchIds.add(branchId);
+    }
+
     /**
      * Add operational limits group attributes to the cache when loading all the operational limits group attributes of an identifiable.<br/>
      * This method is only used to get operational limits group attributes from the server so even if it adds some checks and reduces performance by a tiny bit,
@@ -638,9 +692,11 @@ private void addAllOperationalLimitsGroupAttributesToCache(String branchId, Map<
         Objects.requireNonNull(operationalLimitsGroupAttributesMap);
 
         operationalLimitsGroupAttributesMap.forEach((identifier, limitsGroup) -> {
-            getCachedOperationalLimitsGroupAttributes(identifier.getBranchId(), identifier.getSide())
-                .putIfAbsent(limitsGroup.getId(), limitsGroup);
-            removedOperationalLimitsGroupsAttributes.remove(identifier);
+            if (limitsGroup != null) {
+                getCachedOperationalLimitsGroupAttributes(identifier.getBranchId(), identifier.getSide())
+                    .putIfAbsent(limitsGroup.getId(), limitsGroup);
+                removedOperationalLimitsGroupsAttributes.remove(identifier);
+            }
         });
         fullyLoadedOperationalLimitsGroupsByBranchIds.add(branchId);
     }

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/NetworkObjectIndex.java

@@ -1235,6 +1235,10 @@ public void loadOperationalLimitsGroupAttributes(ResourceType type, String branc
         storeClient.getOperationalLimitsGroupAttributes(network.getUuid(), workingVariantNum, type, branchId, operationalLimitGroupName, side);
     }
 
+    public void loadCurrentLimitsGroupAttributes(ResourceType type, String branchId, String operationalLimitGroupName, int side) {
+        storeClient.getCurrentLimitsGroupAttributes(network.getUuid(), workingVariantNum, type, branchId, operationalLimitGroupName, side);
+    }
+
     public void removeOperationalLimitsGroupAttributes(ResourceType type, String identifiableId, String operationalLimitGroupName, int side) {
         storeClient.removeOperationalLimitsGroupAttributes(network.getUuid(), workingVariantNum, type, identifiableId, operationalLimitGroupName, side);
     }

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/NetworkStoreClient.java

@@ -350,6 +350,20 @@ public interface NetworkStoreClient {
      */
     Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getAllOperationalLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType resourceType);
 
+    /**
+     * For one identifiable with a specific identifiable id, retrieves one extension attributes by its extension name.
+     * @return {@link LimitsAttributes} which is a subset of an identifiable resource. The extension attributes can be put in the
+     * extensionAttributes map of an {@link IdentifiableAttributes} or used to load an extension.
+     */
+    Optional<OperationalLimitsGroupAttributes> getCurrentLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String branchId, String operationalLimitGroupName, int side);
+
+    /**
+     * For all the identifiables of a specific resource type, retrieves all extension attributes of this identifiable.
+     * Used for preloading collection strategy.
+     * @return A {@link Map} where keys are identifiable IDs and values are {@link Map}s where keys are extension names and values are {@link ExtensionAttributes}.
+     */
+    Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getSelectedCurrentLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType resourceType);
+
     Optional<Resource<IdentifiableAttributes>> getIdentifiable(UUID networkUuid, int variantNum, String id);
 
     List<String> getIdentifiablesIds(UUID networkUuid, int variantNum);

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/OfflineNetworkStoreClient.java

@@ -646,6 +646,16 @@ public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupA
         return Map.of();
     }
 
+    @Override
+    public Optional<OperationalLimitsGroupAttributes> getCurrentLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String branchId, String operationalLimitGroupName, int side) {
+        return Optional.empty();
+    }
+
+    @Override
+    public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getSelectedCurrentLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType resourceType) {
+        return Map.of();
+    }
+
     @Override
     public List<Resource<GroundAttributes>> getVoltageLevelGrounds(UUID networkUuid, int variantNum,
             String voltageLevelId) {

network-store-iidm-impl/src/test/java/com/powsybl/network/store/iidm/impl/MockNetworkStoreClient.java

@@ -112,6 +112,16 @@ public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupA
         return Map.of();
     }
 
+    @Override
+    public Optional<OperationalLimitsGroupAttributes> getCurrentLimitsGroupAttributes(UUID networkUuid, int variantNum, ResourceType resourceType, String branchId, String operationalLimitGroupName, int side) {
+        return Optional.empty();
+    }
+
+    @Override
+    public Map<String, Map<OperationalLimitsGroupIdentifier, OperationalLimitsGroupAttributes>> getSelectedCurrentLimitsGroupAttributesByResourceType(UUID networkUuid, int variantNum, ResourceType resourceType) {
+        return Map.of();
+    }
+
     @Override
     public List<NetworkInfos> getNetworksInfos() {
         throw new UnsupportedOperationException("Unimplemented method");