From a365eee5fc3b42bf25ede86ea904250d28eb0f75 Mon Sep 17 00:00:00 2001
From: Dominique Marcadet <Dominique.Marcadet@centralesupelec.fr>
Date: Tue, 7 May 2019 11:02:54 +0200
Subject: [PATCH] WIP. Most of presence condition for DataObject implemented
---
.../nsd/PresenceConditionValidator.java | 868 +++++++++++++++---
1 file changed, 744 insertions(+), 124 deletions(-)
diff --git a/fr.centralesupelec.edf.riseclipse.iec61850.scl.tools/src/fr/centralesupelec/edf/riseclipse/iec61850/scl/validator/nsd/PresenceConditionValidator.java b/fr.centralesupelec.edf.riseclipse.iec61850.scl.tools/src/fr/centralesupelec/edf/riseclipse/iec61850/scl/validator/nsd/PresenceConditionValidator.java
index 796051b..9edd050 100644
--- a/fr.centralesupelec.edf.riseclipse.iec61850.scl.tools/src/fr/centralesupelec/edf/riseclipse/iec61850/scl/validator/nsd/PresenceConditionValidator.java
+++ b/fr.centralesupelec.edf.riseclipse.iec61850.scl.tools/src/fr/centralesupelec/edf/riseclipse/iec61850/scl/validator/nsd/PresenceConditionValidator.java
@@ -3,6 +3,7 @@ package fr.centralesupelec.edf.riseclipse.iec61850.scl.validator.nsd;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map.Entry;
+import java.util.Optional;
import org.apache.commons.lang3.tuple.Pair;
import org.eclipse.emf.common.util.BasicDiagnostic;
@@ -11,7 +12,12 @@ import org.eclipse.emf.common.util.DiagnosticChain;
import fr.centralesupelec.edf.riseclipse.iec61850.nsd.AnyLNClass;
import fr.centralesupelec.edf.riseclipse.iec61850.nsd.DataObject;
+import fr.centralesupelec.edf.riseclipse.iec61850.scl.AnyLN;
+import fr.centralesupelec.edf.riseclipse.iec61850.scl.DAI;
import fr.centralesupelec.edf.riseclipse.iec61850.scl.DO;
+import fr.centralesupelec.edf.riseclipse.iec61850.scl.DOI;
+import fr.centralesupelec.edf.riseclipse.iec61850.scl.LDevice;
+import fr.centralesupelec.edf.riseclipse.iec61850.scl.LN0;
import fr.centralesupelec.edf.riseclipse.iec61850.scl.LNodeType;
import fr.centralesupelec.edf.riseclipse.iec61850.scl.validator.RiseClipseValidatorSCL;
import fr.centralesupelec.edf.riseclipse.util.AbstractRiseClipseConsole;
@@ -30,16 +36,37 @@ public class PresenceConditionValidator {
private AnyLNClass anyLNClass;
private PresenceConditionValidator base;
+
+ private static class SingleOrMultiDO {
+ }
+ private static class SingleDO extends SingleOrMultiDO {
+ DO do_;
+
+ SingleDO( DO do_ ) {
+ this.do_ = do_;
+ }
+ }
+ private static class MultiDO extends SingleOrMultiDO {
+ HashMap< Integer, DO > numberedDOs = new HashMap<>();
+
+ void add( Integer number, DO do_ ) {
+ this.numberedDOs.put( number, do_ );
+ }
+
+ int size() {
+ return numberedDOs.size();
+ }
+ }
// Name of the DataObject/DO, DO
- private HashMap< String, DO > presentDO = new HashMap<>();
+ private HashMap< String, SingleOrMultiDO > presentDO = new HashMap<>();
private HashSet< String > mandatory;
private HashSet< String > optional;
private HashSet< String > forbidden;
// private HashSet< String > notApplicable;
-// private HashSet< String > mandatoryMulti;
-// private HashSet< String > optionalMulti;
+ private HashSet< String > mandatoryMulti;
+ private HashSet< String > optionalMulti;
private HashMap< Integer, HashSet< String > > atLeastOne;
private HashMap< Integer, HashSet< String > > atMostOne;
private HashMap< Integer, HashSet< String > > allOrNonePerGroup;
@@ -54,24 +81,24 @@ public class PresenceConditionValidator {
private HashMap< String, String > optionalIfTextConditionElseForbidden;
private HashMap< String, Pair< Integer, Integer > > mandatoryMultiRange;
private HashMap< String, Pair< Integer, Integer > > optionalMultiRange;
- private HashSet< String > mandatoryIfSubstitutionElseForbidden;
+// private HashSet< String > mandatoryIfSubstitutionElseForbidden;
private HashSet< String > mandatoryInLLN0ElseOptional;
private HashSet< String > mandatoryInLLN0ElseForbidden;
- private HashSet< String > mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional;
- private HashSet< String > mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional;
- private HashSet< String > mandatoryIfAnalogValueIncludesIElseForbidden;
- private HashSet< String > mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden;
- private HashSet< String > mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden;
- private HashSet< String > mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional;
+// private HashSet< String > mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional;
+// private HashSet< String > mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional;
+// private HashSet< String > mandatoryIfAnalogValueIncludesIElseForbidden;
+// private HashSet< String > mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden;
+// private HashSet< String > mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden;
+// private HashSet< String > mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional;
private HashSet< String > mandatoryInRootLogicalDeviceElseOptional;
- private HashSet< String > mandatoryIfControlSupportsTimeElseOptional;
- private HashMap< String, String > oneOrMoreIfSiblingPresentElseForbidden;
- private HashSet< String > mandatoryIfControlSupportsSecurity1ElseOptional;
- private HashSet< String > mandatoryIfControlSupportsSecurity2ElseOptional;
+// private HashSet< String > mandatoryIfControlSupportsTimeElseOptional;
+// private HashMap< String, String > oneOrMoreIfSiblingPresentElseForbidden;
+// private HashSet< String > mandatoryIfControlSupportsSecurity1ElseOptional;
+// private HashSet< String > mandatoryIfControlSupportsSecurity2ElseOptional;
private HashMap< String, String > optionalIfSiblingPresentElseForbidden;
- private HashSet< String > mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2;
- private HashSet< String > mandatoryIfMeasuredValueExposesRange;
- private HashSet< String > optionalIfPhsRefIsSynchrophasorElseMandatory;
+// private HashSet< String > mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2;
+// private HashSet< String > mandatoryIfMeasuredValueExposesRange;
+// private HashSet< String > optionalIfPhsRefIsSynchrophasorElseMandatory;
private final IRiseClipseConsole console = AbstractRiseClipseConsole.getConsole();
@@ -90,7 +117,9 @@ public class PresenceConditionValidator {
}
public void reset() {
- presentDO = new HashMap<>();
+ for( String do_ : presentDO.keySet() ) {
+ presentDO.put( do_, null );
+ }
if( base != null ) base.reset();
}
@@ -127,17 +156,15 @@ public class PresenceConditionValidator {
break;
case "Mmulti" :
// At least one element shall be present; all instances have an instance number > 0
- // -> TODO: not sure what is the instance number and no example found
- console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"Mmulti\" in PresenceCondition" );
-// if( mandatoryMulti == null ) mandatoryMulti = new HashSet<>();
-// mandatoryMulti.add( name );
+ // -> TODO: not sure what is the instance number, it is assumed to be the suffix of DO name
+ if( mandatoryMulti == null ) mandatoryMulti = new HashSet<>();
+ mandatoryMulti.add( name );
break;
case "Omulti" :
// Zero or more elements may be present; all instances have an instance number > 0
- // -> TODO: not sure what is the instance number and no example found
- console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"Omulti\" in PresenceCondition" );
-// if( optionalMulti == null ) optionalMulti = new HashSet<>();
-// optionalMulti.add( name );
+ // -> TODO: not sure what is the instance number, it is assumed to be the suffix of DO name
+ if( optionalMulti == null ) optionalMulti = new HashSet<>();
+ optionalMulti.add( name );
break;
case "AtLeastOne" :
// Parameter n: group number (> 0).
@@ -319,7 +346,7 @@ public class PresenceConditionValidator {
case "MmultiRange" :
// Parameters min, max: limits for instance number (> 0).
// One or more elements shall be present; all instances have an instance number within range [min, max] (see IEC 61850-7-1)
- // -> TODO: not sure what is the instance number and no example found
+ // -> TODO: not sure what is the instance number, it is assumed to be the suffix of DO name
if( mandatoryMultiRange == null ) mandatoryMultiRange = new HashMap<>();
String[] limits1 = presCondArgs.split( "\\d[ ,]+\\d" );
if( limits1.length != 2 ) {
@@ -341,7 +368,7 @@ public class PresenceConditionValidator {
case "OmultiRange" :
// Parameters min, max: limits for instance number (> 0).
// Zero or more elements may be present; all instances have an instance number within range [min, max] (see IEC 61850-7-1)
- // -> TODO: not sure what is the instance number and no example found
+ // -> TODO: not sure what is the instance number, it is assumed to be the suffix of DO name
if( optionalMultiRange == null ) optionalMultiRange = new HashMap<>();
String[] limits2 = presCondArgs.split( "\\d[ ,]+\\d" );
if( limits2.length != 2 ) {
@@ -362,8 +389,10 @@ public class PresenceConditionValidator {
break;
case "MFsubst" :
// Element is mandatory if substitution is supported (for substitution, see IEC 61850-7-3), otherwise forbidden
- if( mandatoryIfSubstitutionElseForbidden == null ) mandatoryIfSubstitutionElseForbidden = new HashSet<>();
- mandatoryIfSubstitutionElseForbidden.add( name );
+ // TODO: how do we know if substitution is supported ?
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MFsubst\" in PresenceCondition" );
+// if( mandatoryIfSubstitutionElseForbidden == null ) mandatoryIfSubstitutionElseForbidden = new HashSet<>();
+// mandatoryIfSubstitutionElseForbidden.add( name );
break;
case "MOln0" :
// Element is mandatory in the context of LLN0; otherwise optional
@@ -378,39 +407,45 @@ public class PresenceConditionValidator {
case "MOlnNs" :
// Element is mandatory if the name space of its logical node deviates from the name space of the containing
// logical device, otherwise optional. See IEC 61850-7-1 for use of name space
- if( mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional == null ) mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional = new HashSet<>();
- mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MOlnNs\" in PresenceCondition" );
+// if( mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional == null ) mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional = new HashSet<>();
+// mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional.add( name );
break;
case "MOdataNs" :
// Element is mandatory if the name space of its data object deviates from the name space of its logical node,
// otherwise optional. See IEC 61850-7-1 for use of name space
- if( mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional == null ) mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional = new HashSet<>();
- mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MOdataNs\" in PresenceCondition" );
+// if( mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional == null ) mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional = new HashSet<>();
+// mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional.add( name );
break;
case "MFscaledAV" :
// Element is mandatory* if any sibling elements of type AnalogueValue include 'i' as a child, otherwise forbidden.
// *Even though devices without floating point capability cannot exchange floating point values through ACSI services,
// the description of scaling remains mandatory for their (SCL) configuration
- if( mandatoryIfAnalogValueIncludesIElseForbidden == null ) mandatoryIfAnalogValueIncludesIElseForbidden = new HashSet<>();
- mandatoryIfAnalogValueIncludesIElseForbidden.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MFscaledAV\" in PresenceCondition" );
+// if( mandatoryIfAnalogValueIncludesIElseForbidden == null ) mandatoryIfAnalogValueIncludesIElseForbidden = new HashSet<>();
+// mandatoryIfAnalogValueIncludesIElseForbidden.add( name );
break;
case "MFscaledMagV" :
// Element is mandatory* if any sibling elements of type Vector include 'i' as a child of their 'mag' attribute, otherwise forbidden.
// *See MFscaledAV
- if( mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden == null ) mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden = new HashSet<>();
- mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MFscaledMagV\" in PresenceCondition" );
+// if( mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden == null ) mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden = new HashSet<>();
+// mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden.add( name );
break;
case "MFscaledAngV" :
// Element is mandatory* if any sibling elements of type Vector include 'i' as a child of their 'ang' attribute, otherwise forbidden.
// *See MFscaledAV
- if( mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden == null ) mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden = new HashSet<>();
- mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MFscaledAngV\" in PresenceCondition" );
+// if( mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden == null ) mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden = new HashSet<>();
+// mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden.add( name );
break;
case "MOrms" :
// Element is mandatory if the harmonic values in the context are calculated as a ratio to RMS value
// (value of data attribute 'hvRef' is 'rms'), optional otherwise
- if( mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional == null ) mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional = new HashSet<>();
- mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MOrms\" in PresenceCondition" );
+// if( mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional == null ) mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional = new HashSet<>();
+// mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional.add( name );
break;
case "MOrootLD" :
// Element is mandatory in the context of a root logical device; otherwise it is optional
@@ -419,33 +454,38 @@ public class PresenceConditionValidator {
break;
case "MOoperTm" :
// Element is mandatory if at least one controlled object on the IED supports time activation service; otherwise it is optional
- if( mandatoryIfControlSupportsTimeElseOptional == null ) mandatoryIfControlSupportsTimeElseOptional = new HashSet<>();
- mandatoryIfControlSupportsTimeElseOptional.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MOoperTm\" in PresenceCondition" );
+// if( mandatoryIfControlSupportsTimeElseOptional == null ) mandatoryIfControlSupportsTimeElseOptional = new HashSet<>();
+// mandatoryIfControlSupportsTimeElseOptional.add( name );
break;
case "MmultiF" :
// Parameter sibling: sibling element name.
// One or more elements must be present if sibling element is present, otherwise forbidden
- if( oneOrMoreIfSiblingPresentElseForbidden == null ) oneOrMoreIfSiblingPresentElseForbidden = new HashMap<>();
- oneOrMoreIfSiblingPresentElseForbidden.put( name, presCondArgs );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MmultiF\" in PresenceCondition" );
+// if( oneOrMoreIfSiblingPresentElseForbidden == null ) oneOrMoreIfSiblingPresentElseForbidden = new HashMap<>();
+// oneOrMoreIfSiblingPresentElseForbidden.put( name, presCondArgs );
break;
case "MOsbo" :
// Element is mandatory if declared control model supports 'sbo-with-normal-security' or 'sbo-with-enhanced-security',
// otherwise optional and value is of no impact
- if( mandatoryIfControlSupportsSecurity1ElseOptional == null ) mandatoryIfControlSupportsSecurity1ElseOptional = new HashSet<>();
- mandatoryIfControlSupportsSecurity1ElseOptional.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MOsbo\" in PresenceCondition" );
+// if( mandatoryIfControlSupportsSecurity1ElseOptional == null ) mandatoryIfControlSupportsSecurity1ElseOptional = new HashSet<>();
+// mandatoryIfControlSupportsSecurity1ElseOptional.add( name );
break;
case "MOenhanced" :
// Element is mandatory if declared control model supports 'direct-with-enhanced-security' or 'sbo-with-enhanced-security',
// otherwise optional and value is of no impact
- if( mandatoryIfControlSupportsSecurity2ElseOptional == null ) mandatoryIfControlSupportsSecurity2ElseOptional = new HashSet<>();
- mandatoryIfControlSupportsSecurity2ElseOptional.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MOenhanced\" in PresenceCondition" );
+// if( mandatoryIfControlSupportsSecurity2ElseOptional == null ) mandatoryIfControlSupportsSecurity2ElseOptional = new HashSet<>();
+// mandatoryIfControlSupportsSecurity2ElseOptional.add( name );
break;
case "MONamPlt" :
// Element is mandatory if the name space of its logical node deviates from the name space of the containing
// logical device, otherwise optional. See IEC 61850-7-1 for use of name space
// TODO: same as "MOlnNs" ?
- if( mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2 == null ) mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2 = new HashSet<>();
- mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MONamPlt\" in PresenceCondition" );
+// if( mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2 == null ) mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2 = new HashSet<>();
+// mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2.add( name );
break;
case "OF" :
// Parameter sibling: sibling element name.
@@ -456,13 +496,15 @@ public class PresenceConditionValidator {
case "MORange" :
// Element is mandatory if the measured value associated (amplitude respectively angle) exposes the range eventing
// (with the attribute range respectively rangeAng)
- if( mandatoryIfMeasuredValueExposesRange == null ) mandatoryIfMeasuredValueExposesRange = new HashSet<>();
- mandatoryIfMeasuredValueExposesRange.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"MORange\" in PresenceCondition" );
+// if( mandatoryIfMeasuredValueExposesRange == null ) mandatoryIfMeasuredValueExposesRange = new HashSet<>();
+// mandatoryIfMeasuredValueExposesRange.add( name );
break;
case "OMSynPh" :
// This attribute is optional if value of 'phsRef'' is Synchrophasor otherwise Mandatory]]></Doc>
- if( optionalIfPhsRefIsSynchrophasorElseMandatory == null ) optionalIfPhsRefIsSynchrophasorElseMandatory = new HashSet<>();
- optionalIfPhsRefIsSynchrophasorElseMandatory.add( name );
+ console.warning( "[NSD] NOT IMPLEMENTED" + name + " declared as \"OMSynPh\" in PresenceCondition" );
+// if( optionalIfPhsRefIsSynchrophasorElseMandatory == null ) optionalIfPhsRefIsSynchrophasorElseMandatory = new HashSet<>();
+// optionalIfPhsRefIsSynchrophasorElseMandatory.add( name );
break;
default:
console.warning( "[NSD] the PresenceCondition " + presCond + " of AnyLNClass " + name + " is unknown" );
@@ -472,82 +514,141 @@ public class PresenceConditionValidator {
}
private void checkSpecification() {
+ // TODO: do we have to check the presence of the sibling in inherited AbstractLNClass ?
if( mandatoryIfSiblingPresentElseForbidden != null ) {
for( Entry< String, String > e : mandatoryIfSiblingPresentElseForbidden.entrySet() ) {
if( ! presentDO.containsKey( e.getValue() )) {
- console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition od DataObject " + e.getKey() + " is unknown" );
+ console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition of DataObject " + e.getKey() + " is unknown" );
}
}
}
if( mandatoryIfSiblingPresentElseOptional != null ) {
for( Entry< String, String > e : mandatoryIfSiblingPresentElseOptional.entrySet() ) {
if( ! presentDO.containsKey( e.getValue() )) {
- console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition od DataObject " + e.getKey() + " is unknown" );
+ console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition of DataObject " + e.getKey() + " is unknown" );
}
}
}
if( optionalIfSiblingPresentElseMandatory != null ) {
for( Entry< String, String > e : optionalIfSiblingPresentElseMandatory.entrySet() ) {
if( ! presentDO.containsKey( e.getValue() )) {
- console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition od DataObject " + e.getKey() + " is unknown" );
+ console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition of DataObject " + e.getKey() + " is unknown" );
}
}
}
if( forbiddenIfSiblingPresentElseMandatory != null ) {
for( Entry< String, String > e : forbiddenIfSiblingPresentElseMandatory.entrySet() ) {
if( ! presentDO.containsKey( e.getValue() )) {
- console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition od DataObject " + e.getKey() + " is unknown" );
- }
- }
- }
- if( oneOrMoreIfSiblingPresentElseForbidden != null ) {
- for( Entry< String, String > e : oneOrMoreIfSiblingPresentElseForbidden.entrySet() ) {
- if( ! presentDO.containsKey( e.getValue() )) {
- console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition od DataObject " + e.getKey() + " is unknown" );
+ console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition of DataObject " + e.getKey() + " is unknown" );
}
}
}
+// if( oneOrMoreIfSiblingPresentElseForbidden != null ) {
+// for( Entry< String, String > e : oneOrMoreIfSiblingPresentElseForbidden.entrySet() ) {
+// if( ! presentDO.containsKey( e.getValue() )) {
+// console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition of DataObject " + e.getKey() + " is unknown" );
+// }
+// }
+// }
if( optionalIfSiblingPresentElseForbidden != null ) {
for( Entry< String, String > e : optionalIfSiblingPresentElseForbidden.entrySet() ) {
if( ! presentDO.containsKey( e.getValue() )) {
- console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition od DataObject " + e.getKey() + " is unknown" );
+ console.warning( "[NSD] the sibling of " + e.getKey() + " in PresenceCondition of DataObject " + e.getKey() + " is unknown" );
}
}
}
}
public boolean addDO( DO do_, DiagnosticChain diagnostics ) {
- if( ! presentDO.containsKey( do_.getName() )) {
+ return addDO( do_, anyLNClass.getName(), diagnostics );
+ }
+
+ private boolean addDO( DO do_, String anyLNClassName, DiagnosticChain diagnostics ) {
+ // An instance number may be set as a suffix
+ String[] names;
+ if( do_.getName().matches( "[a-zA-Z]+\\d+" )) {
+ names = do_.getName().split( "(?=\\d)", 2 );
+ }
+ else {
+ names = new String[] { do_.getName() };
+ }
+ if( names.length == 0 ) {
+ console.error( "[NSD] Unexpected DO name " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() );
+ return false;
+ }
+ if( ! presentDO.containsKey( names[0] )) {
if( base != null ) {
- return base.addDO( do_, diagnostics );
+ return base.addDO( do_, anyLNClassName, diagnostics );
}
diagnostics.add( new BasicDiagnostic(
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + ") not found in LNClass " + anyLNClass.getName(),
+ "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + ") not found in LNClass " + anyLNClassName,
new Object[] { do_ } ));
return false;
}
- if( presentDO.get( do_.getName() ) != null ) {
- diagnostics.add( new BasicDiagnostic(
- Diagnostic.ERROR,
- RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
- 0,
- "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + ") already present in LNClass " + anyLNClass.getName(),
- new Object[] { do_ } ));
- return false;
+ if( names.length == 1 ) {
+ if( presentDO.get( do_.getName() ) != null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + ") already present in LNClass " + anyLNClassName,
+ new Object[] { do_ } ));
+ return false;
+ }
+ presentDO.put( do_.getName(), new SingleDO( do_ ));
+ return true;
+ }
+ if( names.length == 2 ) {
+ if( presentDO.get( names[0] ) == null ) {
+ presentDO.put( names[0], new MultiDO() );
+ }
+ else if( presentDO.get( names[0] ) instanceof SingleDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + ") already present without instance number in LNClass " + anyLNClassName,
+ new Object[] { do_ } ));
+ return false;
+ }
+
+ MultiDO m = ( MultiDO ) presentDO.get( names[0] );
+ Integer number = Integer.valueOf( names[1] );
+
+ if( m.numberedDOs.containsKey( number )) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + ") already present with same instance number in LNClass " + anyLNClassName,
+ new Object[] { do_ } ));
+ return false;
+ }
+ m.add( number, do_ );
+ return true;
}
- presentDO.put( do_.getName(), do_ );
- return true;
+ console.warning( "[NSD] DO " + do_.getName() + " in LNodeType (line " + do_.getParentLNodeType().getLineNumber() + "has an unrecognized name" );
+ return false;
}
public boolean validate( LNodeType lNodeType, DiagnosticChain diagnostics ) {
+ return validate( lNodeType, anyLNClass.getName(), diagnostics );
+ }
+
+ private boolean validate( LNodeType lNodeType, String anyLNClassName, DiagnosticChain diagnostics ) {
boolean res = true;
+ if( base != null ) {
+ res = base.validate( lNodeType, diagnostics );
+ }
+
// presCond: "M"
// Element is mandatory
+ // Usage in standard NSD files (version 2007B): DataObject and DataAttribute and SubDataAttribute
if( mandatory != null ) {
for( String name : this.mandatory ) {
if( presentDO.get( name ) == null ) {
@@ -555,19 +656,44 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] DO " + name + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName(),
+ "[NSD] DO " + name + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
new Object[] { lNodeType } ));
res = false;
}
+ else if( presentDO.get( name ) instanceof MultiDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should not have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
}
}
// presCond: "O"
// Element is optional
- // Nothing to do
+ // Usage in standard NSD files (version 2007B): DataObject and DataAttribute and SubDataAttribute
+ if( optional != null ) {
+ for( String name : this.optional ) {
+ if( presentDO.get( name ) == null ) {
+ }
+ else if( presentDO.get( name ) instanceof MultiDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should not have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
// presCond: "F"
// Element is forbidden
+ // Usage in standard NSD files (version 2007B): DataObject
if( forbidden != null ) {
for( String name : this.forbidden ) {
if( presentDO.get( name ) != null ) {
@@ -575,28 +701,79 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] DO " + name + " is forbidden in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName(),
+ "[NSD] DO " + name + " is forbidden in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
new Object[] { lNodeType } ));
res = false;
}
+ else if( presentDO.get( name ) instanceof MultiDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should not have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
}
}
// presCond: "na"
// Element is not applicable
+ // Usage in standard NSD files (version 2007B): only for dsPresCond
// -> TODO: what does it mean ? what do we have to check ?
+// if( notApplicable != null ) {
+//
+// }
// presCond: "Mmulti"
// At least one element shall be present; all instances have an instance number > 0
- // -> TODO: not sure what is the instance number and no example found
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( mandatoryMulti != null ) {
+ for( String name : this.mandatoryMulti ) {
+ if( presentDO.get( name ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] At least one DO " + name + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ else if( presentDO.get( name ) instanceof SingleDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
// presCond: "Omulti"
// Zero or more elements may be present; all instances have an instance number > 0
- // -> TODO: not sure what is the instance number and no example found
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( optionalMulti != null ) {
+ for( String name : this.optionalMulti ) {
+ if( presentDO.get( name ) == null ) {
+ }
+ else if( presentDO.get( name ) instanceof SingleDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
// presCond: "AtLeastOne"
// Parameter n: group number (> 0).
// At least one of marked elements of a group n shall be present
+ // Usage in standard NSD files (version 2007B): DataObject and SubDataObject and DataAttribute and SubDataAttribute
if( atLeastOne != null ) {
for( Entry< Integer, HashSet< String > > e1 : atLeastOne.entrySet() ) {
boolean groupOK = false;
@@ -611,14 +788,16 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] group " + e1.getKey() + " has no elements in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName(),
+ "[NSD] group " + e1.getKey() + " has no elements in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
new Object[] { lNodeType } ));
res = false;
}
}
}
+
// presCond: "AtMostOne" :
// At most one of marked elements shall be present
+ // Usage in standard NSD files (version 2007B): DataObject
if( atMostOne != null ) {
for( Entry< Integer, HashSet< String > > e1 : atMostOne.entrySet() ) {
int groupCount = 0;
@@ -632,15 +811,17 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] group " + e1.getKey() + " has more than one element in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName(),
+ "[NSD] group " + e1.getKey() + " has more than one element in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
new Object[] { lNodeType } ));
res = false;
}
}
}
+
// presCond: "AllOrNonePerGroup" :
// Parameter n: group number (> 0).
// All or none of the elements of a group n shall be present
+ // Usage in standard NSD files (version 2007B): DataAttribute
if( allOrNonePerGroup != null ) {
for( Entry< Integer, HashSet< String > > e1 : allOrNonePerGroup.entrySet() ) {
int groupCount = 0;
@@ -654,15 +835,17 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] group " + e1.getKey() + " has neither none nor all elements in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName(),
+ "[NSD] group " + e1.getKey() + " has neither none nor all elements in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
new Object[] { lNodeType } ));
res = false;
}
}
}
+
// presCond: "AllOnlyOneGroup" :
// Parameter n: group number (> 0).
// All elements of only one group n shall be present
+ // Usage in standard NSD files (version 2007B): DataObject and SubDataAttribute
if( allOnlyOneGroup != null ) {
int groupNumber = 0;
for( Entry< Integer, HashSet< String > > e1 : allOnlyOneGroup.entrySet() ) {
@@ -677,7 +860,7 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] group " + e1.getKey() + " has neither none nor all elements in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName(),
+ "[NSD] group " + e1.getKey() + " has neither none nor all elements in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
new Object[] { lNodeType } ));
res = false;
}
@@ -690,7 +873,7 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName() + " has several groups with all elements",
+ "[NSD] LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName + " has several groups with all elements",
new Object[] { lNodeType } ));
res = false;
}
@@ -701,14 +884,16 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] no group in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName() + " has all elements",
+ "[NSD] no group in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName + " has all elements",
new Object[] { lNodeType } ));
res = false;
}
}
+
// presCond: "AllAtLeastOneGroup" :
// Parameter n: group number (> 0).
// All elements of at least one group n shall be present
+ // Usage in standard NSD files (version 2007B): DataAttribute
if( allAtLeastOneGroup != null ) {
int groupNumber = 0;
for( Entry< Integer, HashSet< String > > e1 : allAtLeastOneGroup.entrySet() ) {
@@ -727,122 +912,557 @@ public class PresenceConditionValidator {
Diagnostic.ERROR,
RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
0,
- "[NSD] no group in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClass.getName() + " has all elements",
+ "[NSD] no group in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName + " has all elements",
new Object[] { lNodeType } ));
res = false;
}
}
- /*
+
// presCond: "MF" :
// Parameter sibling: sibling element name.
// Mandatory if sibling element is present, otherwise forbidden
- mandatoryIfSiblingPresentElseForbidden.put( name, Pair.of( mandatoryIfSiblingPresentElseForbidden.get( name ).getKey(), true ));
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( mandatoryIfSiblingPresentElseForbidden != null ) {
+ for( Entry< String, String > entry : mandatoryIfSiblingPresentElseForbidden.entrySet() ) {
+ if( presentDO.get( entry.getValue() ) != null ) {
+ if( presentDO.get( entry.getKey() ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ else {
+ if( presentDO.get( entry.getKey() ) != null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is forbidden in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is not present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+
// presCond: "MO" :
// Parameter sibling: sibling element name.
// Mandatory if sibling element is present, otherwise optional
- mandatoryIfSiblingPresentElseOptional.put( name, Pair.of( mandatoryIfSiblingPresentElseOptional.get( name ).getKey(), true ));
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ if( mandatoryIfSiblingPresentElseOptional != null ) {
+ for( Entry< String, String > entry : mandatoryIfSiblingPresentElseOptional.entrySet() ) {
+ if( presentDO.get( entry.getValue() ) != null ) {
+ if( presentDO.get( entry.getKey() ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+
// presCond: "OM" :
// Parameter sibling: sibling element name.
// Optional if sibling element is present, otherwise mandatory
- optionalIfSiblingPresentElseMandatory.put( name, Pair.of( optionalIfSiblingPresentElseMandatory.get( name ).getKey(), true ));
+ // Usage in standard NSD files (version 2007B): None
+ if( optionalIfSiblingPresentElseMandatory != null ) {
+ for( Entry< String, String > entry : optionalIfSiblingPresentElseMandatory.entrySet() ) {
+ if( presentDO.get( entry.getValue() ) == null ) {
+ if( presentDO.get( entry.getKey() ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is not present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+
// presCond: "FM" :
// Parameter sibling: sibling element name.
// Forbidden if sibling element is present, otherwise mandatory
- forbiddenIfSiblingPresentElseMandatory.put( name, Pair.of( forbiddenIfSiblingPresentElseMandatory.get( name ).getKey(), true ));
+ // Usage in standard NSD files (version 2007B): None
+ if( forbiddenIfSiblingPresentElseMandatory != null ) {
+ for( Entry< String, String > entry : forbiddenIfSiblingPresentElseMandatory.entrySet() ) {
+ if( presentDO.get( entry.getValue() ) != null ) {
+ if( presentDO.get( entry.getKey() ) != null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is forbidden in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ else {
+ if( presentDO.get( entry.getKey() ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is not present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+
// presCond: "MOcond" :
// Parameter condID: condition number (> 0).
// Textual presence condition (non-machine processable) with reference condID to context specific text.
// If satisfied, the element is mandatory, otherwise optional
- mandatoryIfTextConditionElseOptional.put( name, Pair.of( mandatoryIfTextConditionElseOptional.get( name ).getKey(), false ));
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( mandatoryIfTextConditionElseOptional != null ) {
+ for( Entry< String, String > entry : mandatoryIfTextConditionElseOptional.entrySet() ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.WARNING,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " if textual condition " + entry.getValue() + " (not evaluated) is true, else optional. It is "
+ + ( presentDO.get( entry.getKey() ) == null ? "absent" : "present" ),
+ new Object[] { lNodeType } ));
+ }
+ }
+
// presCond: "MFcond" :
// Parameter condID: condition number (> 0).
// Textual presence condition (non-machine processable) with reference condID to context specific text.
// If satisfied, the element is mandatory, otherwise forbidden
- mandatoryIfTextConditionElseForbidden.put( name, Pair.of( mandatoryIfTextConditionElseForbidden.get( name ).getKey(), false ));
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( mandatoryIfTextConditionElseForbidden != null ) {
+ for( Entry< String, String > entry : mandatoryIfTextConditionElseForbidden.entrySet() ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.WARNING,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " if textual condition " + entry.getValue() + " (not evaluated) is true, else forbidden. It is "
+ + ( presentDO.get( entry.getKey() ) == null ? "absent" : "present" ),
+ new Object[] { lNodeType } ));
+ }
+ }
+
// presCond: "OFcond" :
// Parameter condID: condition number (> 0).
// Textual presence condition (non-machine processable) with reference condID to context specific text.
// If satisfied, the element is optional, otherwise forbidden
- optionalIfTextConditionElseForbidden.put( name, Pair.of( optionalIfTextConditionElseForbidden.get( name ).getKey(), false ));
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( optionalIfTextConditionElseForbidden != null ) {
+ for( Entry< String, String > entry : optionalIfTextConditionElseForbidden.entrySet() ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.WARNING,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is optional in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " if textual condition " + entry.getValue() + " (not evaluated) is true, else forbidden. It is "
+ + ( presentDO.get( entry.getKey() ) == null ? "absent" : "present" ),
+ new Object[] { lNodeType } ));
+ }
+ }
+
// presCond: "MmultiRange" :
// Parameters min, max: limits for instance number (> 0).
// One or more elements shall be present; all instances have an instance number within range [min, max] (see IEC 61850-7-1)
- // -> TODO: not sure what is the instance number and no example found
- mandatoryMultiRange.put( name, Pair.of( Pair.of( min1, max1 ), new HashSet<>() ));
+ // Usage in standard NSD files (version 2007B): None
+ if( mandatoryMultiRange != null ) {
+ for( String name : this.mandatoryMultiRange.keySet() ) {
+ if( presentDO.get( name ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] At least one DO " + name + " is mandatory in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ else if( presentDO.get( name ) instanceof SingleDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ else {
+ MultiDO m = ( MultiDO ) presentDO.get( name );
+ for( Integer n : m.numberedDOs.keySet() ) {
+ Integer min = mandatoryMultiRange.get( name ).getLeft();
+ Integer max = mandatoryMultiRange.get( name ).getRight();
+ if(( n < min ) || ( n > max )) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should have an instance number in range [" + min + "," + max + "] in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+ }
+
// presCond: "OmultiRange" :
// Parameters min, max: limits for instance number (> 0).
// Zero or more elements may be present; all instances have an instance number within range [min, max] (see IEC 61850-7-1)
- // -> TODO: not sure what is the instance number and no example found
- optionalMultiRange.put( name, Pair.of( Pair.of( min2, max2 ), new HashSet<>() ));
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( optionalMultiRange != null ) {
+ for( String name : this.optionalMultiRange.keySet() ) {
+ if( presentDO.get( name ) == null ) {
+ }
+ else if( presentDO.get( name ) instanceof SingleDO ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should have an instance number in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ else {
+ MultiDO m = ( MultiDO ) presentDO.get( name );
+ for( Integer n : m.numberedDOs.keySet() ) {
+ Integer min = optionalMultiRange.get( name ).getLeft();
+ Integer max = optionalMultiRange.get( name ).getRight();
+ if(( n < min ) || ( n > max )) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " should have an instance number in range [" + min + "," + max + "] in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+ }
+
// presCond: "MFsubst" :
// Element is mandatory if substitution is supported (for substitution, see IEC 61850-7-3), otherwise forbidden
- mandatoryIfSubstitutionElseForbidden.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfSubstitutionElseForbidden != null ) {
+//
+// }
+
// presCond: "MOln0" :
// Element is mandatory in the context of LLN0; otherwise optional
- mandatoryInLLN0ElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ if( mandatoryInLLN0ElseOptional != null ) {
+ for( String name : mandatoryInLLN0ElseOptional ) {
+ if( presentDO.get( name ) == null ) {
+ for( AnyLN anyLN : lNodeType.getReferredByAnyLN() ) {
+ if( anyLN instanceof LN0 ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " is mandatory in LN0 in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+ }
+
// presCond: "MFln0" :
// Element is mandatory in the context of LLN0; otherwise forbidden
- mandatoryInLLN0ElseForbidden.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ if( mandatoryInLLN0ElseForbidden != null ) {
+ for( String name : mandatoryInLLN0ElseForbidden ) {
+ for( AnyLN anyLN : lNodeType.getReferredByAnyLN() ) {
+ if( presentDO.get( name ) == null ) {
+ if( anyLN instanceof LN0 ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " is mandatory in LN0 in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ else {
+ if( ! ( anyLN instanceof LN0 )) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " is forbidden in LN in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass " + anyLNClassName,
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+ }
+
// presCond: "MOlnNs" :
// Element is mandatory if the name space of its logical node deviates from the name space of the containing
// logical device, otherwise optional. See IEC 61850-7-1 for use of name space
- mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO: The meaning is not clear.
+ /*
+ if( mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional != null ) {
+ for( String name : mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional ) {
+ for( AnyLN anyLN : lNodeType.getReferredByAnyLN() ) {
+ Optional< DOI > namPlt1 =
+ anyLN
+ .getDOI()
+ .stream()
+ .filter( doi -> "NamPlt".equals( doi.getName() ))
+ .findFirst();
+ if( ! namPlt1.isPresent() ) {
+ console.warning( "[NSD] while validating presence condition \"MOlnNs\" of LNodeTYPE (line " + lNodeType.getLineNumber()
+ + ") in AnyLN (line " + anyLN.getLineNumber() + ") : cannot find DOI \"NamPlt\" in AnyLN" );
+ continue;
+ }
+ Optional< DAI > lnNs =
+ namPlt1
+ .get()
+ .getDAI()
+ .stream()
+ .filter( dai -> "lnNs".equals( dai.getName() ))
+ .findFirst();
+ if( ! lnNs.isPresent() ) {
+ console.warning( "[NSD] while validating presence condition \"MOlnNs\" of LNodeTYPE (line " + lNodeType.getLineNumber()
+ + ") in AnyLN (line " + anyLN.getLineNumber() + ") : cannot find DAI \"lnNs\"" );
+ continue;
+ }
+ if( ! lnNs.get().isSetVal() ) {
+ console.warning( "[NSD] while validating presence condition \"MOlnNs\" of LNodeTYPE (line " + lNodeType.getLineNumber()
+ + ") in AnyLN (line " + anyLN.getLineNumber() + ") : no Val in \"lnNs\"" );
+ continue;
+ }
+
+ LN0 ln0 = anyLN.getParentLDevice().getLN0();
+ Optional< DOI > namPlt2 =
+ ln0
+ .getDOI()
+ .stream()
+ .filter( doi -> "NamPlt".equals( doi.getName() ))
+ .findFirst();
+ if( ! namPlt2.isPresent() ) {
+ console.warning( "[NSD] while validating presence condition \"MOlnNs\" of LNodeTYPE (line " + lNodeType.getLineNumber()
+ + ") in AnyLN (line " + anyLN.getLineNumber() + ") : cannot find DOI \"NamPlt\" in LN0" );
+ continue;
+ }
+ Optional< DAI > ldNs =
+ namPlt2
+ .get()
+ .getDAI()
+ .stream()
+ .filter( dai -> "ldNs".equals( dai.getName() ))
+ .findFirst();
+ if( ! ldNs.isPresent() ) {
+ console.warning( "[NSD] while validating presence condition \"MOlnNs\" of LNodeTYPE (line " + lNodeType.getLineNumber()
+ + ") in AnyLN (line " + anyLN.getLineNumber() + ") : cannot find DAI \"ldNs\"" );
+ continue;
+ }
+ if( ! ldNs.get().isSetVal() ) {
+ console.warning( "[NSD] while validating presence condition \"MOlnNs\" of LNodeTYPE (line " + lNodeType.getLineNumber()
+ + ") in AnyLN (line " + anyLN.getLineNumber() + ") : no Val in \"ldNs\"" );
+ continue;
+ }
+
+ if( ! ( lnNs.get().getVal().equals( ldNs.get().getVal() ))) {
+ if( presentDO.get( name ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " is mandatory in LN in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because logical node name space deviates from logical device name space",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+ }
+ */
+
// presCond: "MOdataNs" :
// Element is mandatory if the name space of its data object deviates from the name space of its logical node,
// otherwise optional. See IEC 61850-7-1 for use of name space
- mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO: The meaning is not clear.
+// if( mandatoryIfNameSpaceOfDataObjectDeviatesElseOptional != null ) {
+//
+// }
+
// presCond: "MFscaledAV" :
// Element is mandatory* if any sibling elements of type AnalogueValue include 'i' as a child, otherwise forbidden.
// *Even though devices without floating point capability cannot exchange floating point values through ACSI services,
// the description of scaling remains mandatory for their (SCL) configuration
- mandatoryIfAnalogValueIncludesIElseForbidden.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfAnalogValueIncludesIElseForbidden != null ) {
+//
+// }
+
// presCond: "MFscaledMagV" :
// Element is mandatory* if any sibling elements of type Vector include 'i' as a child of their 'mag' attribute, otherwise forbidden.
// *See MFscaledAV
- mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfVectorSiblingIncludesIAsChildMagElseForbidden != null ) {
+//
+// }
+
// presCond: "MFscaledAngV" :
// Element is mandatory* if any sibling elements of type Vector include 'i' as a child of their 'ang' attribute, otherwise forbidden.
// *See MFscaledAV
- mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfVectorSiblingIncludesIAsChildAngElseForbidden != null ) {
+//
+// }
+
// presCond: "MOrms" :
// Element is mandatory if the harmonic values in the context are calculated as a ratio to RMS value
// (value of data attribute 'hvRef' is 'rms'), optional otherwise
- mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfHarmonicValuesCalculatedAsRatioElseOptional != null ) {
+//
+// }
+
// presCond: "MOrootLD" :
// Element is mandatory in the context of a root logical device; otherwise it is optional
- mandatoryInRootLogicalDeviceElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataObject
+ if( mandatoryInRootLogicalDeviceElseOptional != null ) {
+ for( String name : mandatoryInRootLogicalDeviceElseOptional ) {
+ for( AnyLN anyLN : lNodeType.getReferredByAnyLN() ) {
+ Optional< DOI > grRef =
+ anyLN
+ .getParentLDevice()
+ .getLN0()
+ .getDOI()
+ .stream()
+ .filter( doi -> "GrRef".equals( doi.getName() ))
+ .findFirst();
+ if( ! grRef.isPresent() ) {
+ if( presentDO.get( name ) == null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + name + " is mandatory in LN in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " in the context of a root logical device",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+ }
+
// presCond: "MOoperTm" :
// Element is mandatory if at least one controlled object on the IED supports time activation service; otherwise it is optional
- mandatoryIfControlSupportsTimeElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfControlSupportsTimeElseOptional != null ) {
+//
+// }
+
// presCond: "MmultiF" :
// Parameter sibling: sibling element name.
// One or more elements must be present if sibling element is present, otherwise forbidden
- oneOrMoreIfSiblingPresentElseForbidden.put( name, Pair.of( presCondArgs, false ));
+ // Usage in standard NSD files (version 2007B): DataObject
+ // TODO: One or more elements ? Is there an instance number ?
+// if( oneOrMoreIfSiblingPresentElseForbidden != null ) {
+//
+// }
+
// presCond: "MOsbo" :
// Element is mandatory if declared control model supports 'sbo-with-normal-security' or 'sbo-with-enhanced-security',
// otherwise optional and value is of no impact
- mandatoryIfControlSupportsSecurity1ElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfControlSupportsSecurity1ElseOptional != null ) {
+//
+// }
+
// presCond: "MOenhanced" :
// Element is mandatory if declared control model supports 'direct-with-enhanced-security' or 'sbo-with-enhanced-security',
// otherwise optional and value is of no impact
- mandatoryIfControlSupportsSecurity2ElseOptional.put( name, false );
+ // Usage in standard NSD files (version 2007B): DataAttribute
+ // TODO
+// if( mandatoryIfControlSupportsSecurity2ElseOptional != null ) {
+//
+// }
+
// presCond: "MONamPlt" :
// Element is mandatory if the name space of its logical node deviates from the name space of the containing
// logical device, otherwise optional. See IEC 61850-7-1 for use of name space
+ // Usage in standard NSD files (version 2007B): DataObject
// TODO: same as "MOlnNs" ?
- mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2.put( name, false );
+// if( mandatoryIfNameSpaceOfLogicalNodeDeviatesElseOptional2 != null ) {
+//
+// }
+
// presCond: "OF" :
// Parameter sibling: sibling element name.
// Optional if sibling element is present, otherwise forbidden
- optionalIfSiblingPresentElseForbidden.put( name, Pair.of( presCondArgs, false ));
+ // Usage in standard NSD files (version 2007B): DataObject and DataAttribute
+ if( optionalIfSiblingPresentElseForbidden != null ) {
+ for( Entry< String, String > entry : optionalIfSiblingPresentElseForbidden.entrySet() ) {
+ if( presentDO.get( entry.getValue() ) == null ) {
+ if( presentDO.get( entry.getKey() ) != null ) {
+ diagnostics.add( new BasicDiagnostic(
+ Diagnostic.ERROR,
+ RiseClipseValidatorSCL.DIAGNOSTIC_SOURCE,
+ 0,
+ "[NSD] DO " + entry.getKey() + " is forbidden in LNodeType (line " + lNodeType.getLineNumber() + ") with LNClass "
+ + anyLNClassName + " because sibling " + entry.getValue() + " is not present",
+ new Object[] { lNodeType } ));
+ res = false;
+ }
+ }
+ }
+ }
+
// presCond: "MORange" :
// Element is mandatory if the measured value associated (amplitude respectively angle) exposes the range eventing
// (with the attribute range respectively rangeAng)
- mandatoryIfMeasuredValueExposesRange.put( name, false );
+ // Usage in standard NSD files (version 2007B): SubDataAttribute
+ // TODO
+// if( mandatoryIfMeasuredValueExposesRange != null ) {
+//
+// }
+
// presCond: "OMSynPh" :
// This attribute is optional if value of 'phsRef'' is Synchrophasor otherwise Mandatory]]></Doc>
- optionalIfPhsRefIsSynchrophasorElseMandatory.put( name, false );
-*/
+ // Usage in standard NSD files (version 2007B): SubDataObject
+ // TODO
+// if( optionalIfPhsRefIsSynchrophasorElseMandatory != null ) {
+//
+// }
+
return res;
}
--
GitLab