Merge pull request #45 from com-pas/extref-list-cb-for-signal

SCL TExtref management (Signal, Binding and ControlBlocks)

Author: AliouDIAITE

pom.xml

@@ -57,12 +57,6 @@
                 <artifactId>logback-classic</artifactId>
                 <version>1.2.6</version>
             </dependency>
-            <!--<dependency>
-                <groupId>org.slf4j</groupId>
-                <artifactId>slf4j-log4j12</artifactId>
-                <version>1.7.32</version>
-                <scope>test</scope>
-            </dependency>-->
         </dependencies>
     </dependencyManagement>
     <dependencies>

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ControlBlock.java

@@ -22,20 +22,29 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 
 @Getter
 @Setter
 @NoArgsConstructor
 public abstract class ControlBlock<T extends ControlBlock> {
+
     protected String id; /// appID or smvID
     protected String name;
     protected String dataSetRef;
     protected String desc;
     protected long confRev;
     protected List<TControlWithIEDName.IEDName> iedNames = new ArrayList<>();
     protected TPredefinedTypeOfSecurityEnum securityEnable = TPredefinedTypeOfSecurityEnum.NONE;
+    // summarized info about the LN holding this CB
+    protected String iedName;
+    protected String ldInst;
+    protected String prefix;
+    protected String lnClass;
+    protected String lnInst;
+
 
     protected abstract Class<T> getClassType();
     public abstract TServiceType getServiceType();

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/DataTypeName.java

@@ -18,11 +18,13 @@
 @Getter
 @Setter
 public class DataTypeName {
-    protected String name;
+    protected String name = "";
     protected String validationPattern = "";
     private List<String> structNames = new ArrayList<>();
 
-    public DataTypeName(@NonNull String dataName){
+    public DataTypeName(String dataName){
+        if(dataName == null) return;
+
         String[] tokens = dataName.split("\\.");
         name = tokens[0];
         if(tokens.length > 1){

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ExtRefBindingInfo.java

@@ -9,6 +9,7 @@
 import lombok.Setter;
 import org.apache.commons.lang3.StringUtils;
 import org.lfenergy.compas.scl2007b4.model.TExtRef;
+import org.lfenergy.compas.scl2007b4.model.TFCDA;
 import org.lfenergy.compas.scl2007b4.model.TLLN0Enum;
 import org.lfenergy.compas.scl2007b4.model.TServiceType;
 
@@ -76,7 +77,7 @@ public int hashCode() {
 
     public boolean isValid() {
         final String validationRegex = DaTypeName.VALIDATION_REGEX;
-        String doRef = doName.toString();
+        String doRef = doName == null ? "" : doName.toString();
 
         Pattern pattern = Pattern.compile(validationRegex,Pattern.MULTILINE);
         Matcher matcher = pattern.matcher(doRef);
@@ -90,4 +91,38 @@ public boolean isValid() {
                 !StringUtils.isBlank(lnClass) &&
                 (TLLN0Enum.LLN_0.value().equals(lnClass) || !StringUtils.isBlank(lnInst)) ;
     }
+
+    public boolean isWrappedIn(TExtRef tExtRef){
+        return Objects.equals(iedName,tExtRef.getIedName()) &&
+                Objects.equals(ldInst,tExtRef.getLdInst()) &&
+                Objects.equals(prefix, tExtRef.getPrefix()) &&
+                Objects.equals(lnInst, tExtRef.getLnInst()) &&
+                tExtRef.getLnClass().contains(lnClass) &&
+                Objects.equals(serviceType, tExtRef.getServiceType());
+    }
+
+    public boolean isNull(){
+        return iedName == null &&
+                ldInst == null &&
+                prefix == null &&
+                lnInst == null &&
+                lnClass == null &&
+                doName == null &&
+                daName == null &&
+                serviceType == null;
+    }
+
+
+    @Override
+    public String toString() {
+        return "ExtRefBindingInfo{" +
+                "iedName='" + iedName + '\'' +
+                ", ldInst='" + ldInst + '\'' +
+                ", prefix='" + prefix + '\'' +
+                ", lnClass='" + lnClass + '\'' +
+                ", lnInst='" + lnInst + '\'' +
+                ", lnType='" + lnType + '\'' +
+                ", serviceType=" + serviceType.value() +
+                '}';
+    }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ExtRefInfo.java

@@ -7,19 +7,26 @@
 
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import lombok.NonNull;
 import lombok.Setter;
+import org.apache.commons.lang3.StringUtils;
 import org.lfenergy.compas.scl2007b4.model.TExtRef;
+import org.lfenergy.compas.scl2007b4.model.TFCDA;
+import org.lfenergy.compas.scl2007b4.model.TLLN0Enum;
+import org.lfenergy.compas.sct.commons.scl.ied.AbstractLNAdapter;
+
+import java.util.Objects;
 
 
 @Getter
 @Setter
 @NoArgsConstructor
 public class ExtRefInfo {
-    private String iedName;
-    private String ldInst;
-    private String prefix;
-    private String lnClass;
-    private String lnInst;
+    private String holderIedName;
+    private String holderLdInst;
+    private String holderPrefix = "";
+    private String holderLnClass;
+    private String holderLnInst = "";
 
     private ExtRefSignalInfo signalInfo;
     private ExtRefBindingInfo bindingInfo;
@@ -30,4 +37,40 @@ public ExtRefInfo(TExtRef tExtRef) {
         sourceInfo = new ExtRefSourceInfo(tExtRef);
         signalInfo = new ExtRefSignalInfo(tExtRef);
     }
+
+    public boolean matchFCDA(@NonNull TFCDA tfcda){
+        if(AbstractLNAdapter.isNull(tfcda)) {
+            return false;
+        }
+
+        if(tfcda.getLdInst() != null &&
+                (bindingInfo == null || !tfcda.getLdInst().equals(bindingInfo.getLdInst()))){
+            return false;
+        }
+        if (!tfcda.getLnClass().isEmpty() &&
+                ( bindingInfo == null || !tfcda.getLnClass().contains(bindingInfo.getLnClass())) ){
+            return false;
+        }
+
+        boolean isLN0 = tfcda.getLnClass().contains(TLLN0Enum.LLN_0.value());
+        if (!isLN0 && tfcda.getLnInst() != null &&
+                (bindingInfo == null || !tfcda.getLnInst().equals(bindingInfo.getLnInst()))) {
+            return false;
+        }
+        if (!isLN0 && !StringUtils.isBlank(tfcda.getPrefix()) &&
+                (bindingInfo == null || !tfcda.getPrefix().equals(bindingInfo.getPrefix()))) {
+            return false;
+        }
+
+        if(!StringUtils.isBlank(tfcda.getDoName()) &&
+                (signalInfo == null || !Objects.equals(signalInfo.getPDO(),tfcda.getDoName())) ){
+            return false;
+        }
+
+        if(!StringUtils.isBlank(tfcda.getDaName()) &&
+                (signalInfo == null || !Objects.equals(signalInfo.getPDA(),tfcda.getDaName())) ){
+            return false;
+        }
+        return true;
+    }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ExtRefSignalInfo.java

@@ -96,4 +96,16 @@ public boolean isValid() {
 
         return true;
     }
+
+    @Override
+    public String toString() {
+        return "ExtRefSignalInfo{" +
+                "desc='" + desc + '\'' +
+                ", pLN='" + pLN + '\'' +
+                ", pDO='" + pDO + '\'' +
+                ", pDA='" + pDA + '\'' +
+                ", intAddr='" + intAddr + '\'' +
+                ", pServT=" + pServT.value() +
+                '}';
+    }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ExtRefSourceInfo.java

@@ -17,9 +17,9 @@
 @NoArgsConstructor
 public class ExtRefSourceInfo {
     private String srcLDInst;
-    private String srcPrefix;
+    private String srcPrefix = "";
     private String srcLNClass;
-    private String srcLNInst;
+    private String srcLNInst = "";
     private String srcCBName;
 
     public ExtRefSourceInfo(TExtRef tExtRef){
@@ -49,4 +49,12 @@ public boolean equals(Object o) {
     public int hashCode() {
         return Objects.hash(srcLDInst, srcPrefix, srcLNClass, srcLNInst, srcCBName);
     }
+
+    public boolean isNull(){
+        return srcCBName == null &&
+                srcLDInst == null &&
+                srcLNClass == null &&
+                srcLNInst == null &&
+                srcPrefix == null;
+    }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/FCDAInfo.java

@@ -58,8 +58,6 @@ public TFCDA getFCDA(){
     }
 
     public boolean isValid() {
-        return doName != null &&
-                !StringUtils.isBlank(doName.getName()) &&
-                !doName.getStructNames().isEmpty();
+        return doName != null && !StringUtils.isBlank(doName.toString());
     }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/IedDTO.java

@@ -6,8 +6,6 @@
 
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import lombok.Setter;
-import org.lfenergy.compas.scl2007b4.model.TLDevice;
 import org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter;
 import org.lfenergy.compas.sct.commons.scl.ied.LDeviceAdapter;
 

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/LDeviceDTO.java

@@ -6,18 +6,19 @@
 
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import lombok.Setter;
-import org.lfenergy.compas.sct.commons.scl.ied.AbstractLNAdapter;
+
+import lombok.extern.slf4j.Slf4j;
+import org.lfenergy.compas.sct.commons.Utils;
 import org.lfenergy.compas.sct.commons.scl.ied.LDeviceAdapter;
-import org.lfenergy.compas.sct.commons.scl.ied.LN0Adapter;
 import org.lfenergy.compas.sct.commons.scl.ied.LNAdapter;
 
-import java.util.Collection;
+
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
 
+@Slf4j
 @Getter
 @NoArgsConstructor
 public class LDeviceDTO {
@@ -31,15 +32,18 @@ public LDeviceDTO(String inst, String ldName) {
     }
 
     public static LDeviceDTO from(LDeviceAdapter lDeviceAdapter, LogicalNodeOptions options) {
+        log.info(Utils.entering());
         LDeviceDTO lDeviceDTO = new LDeviceDTO();
-        lDeviceDTO.ldInst = lDeviceAdapter.getInst();
-        lDeviceDTO.ldName = lDeviceAdapter.getLdName();
-        List<LNAdapter> lnAdapters = lDeviceAdapter.getLNAdapters();
-        lDeviceDTO.lNodes = lnAdapters.stream()
-                .map(lnAdapter -> LNodeDTO.from(lnAdapter, options))
-                .collect(Collectors.toSet());
-        lDeviceDTO.lNodes.add(LNodeDTO.from(lDeviceAdapter.getLN0Adapter(),options));
-
+        if(lDeviceAdapter != null) {
+            lDeviceDTO.ldInst = lDeviceAdapter.getInst();
+            lDeviceDTO.ldName = lDeviceAdapter.getLdName();
+            lDeviceDTO.lNodes.add(LNodeDTO.from(lDeviceAdapter.getLN0Adapter(), options));
+            List<LNAdapter> lnAdapters = lDeviceAdapter.getLNAdapters();
+            lDeviceDTO.lNodes = lnAdapters.stream()
+                    .map(lnAdapter -> LNodeDTO.from(lnAdapter, options))
+                    .collect(Collectors.toSet());
+        }
+        log.info(Utils.leaving());
         return lDeviceDTO;
     }