src/Model/Model_Validator.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_Validator.cpp
   4 // Created:     2 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #include <Model_Validator.h>
   8 #include <Model_FeatureValidator.h>
   9 #include <ModelAPI_Feature.h>
  10 #include <ModelAPI_Attribute.h>
  11 #include <ModelAPI_Data.h>
  12 #include <ModelAPI_AttributeValidator.h>
  13 #include <ModelAPI_AttributeString.h>
  14 #include <Events_Error.h>
  15
  16 void Model_ValidatorsFactory::registerValidator(const std::string& theID,
  17   ModelAPI_Validator* theValidator)
  18 {
  19   if (myIDs.find(theID) != myIDs.end()) {
  20     Events_Error::send(std::string("Validator ") + theID + " is already registered");
  21   } else {
  22     myIDs[theID] = theValidator;
  23   }
  24 }
  25
  26 void Model_ValidatorsFactory::assignValidator(const std::string& theID,
  27   const std::string& theFeatureID)
  28 {
  29   if (myFeatures.find(theFeatureID) == myFeatures.end()) {
  30     myFeatures[theFeatureID] = AttrValidators();
  31   }
  32   if (myFeatures[theFeatureID].find(theID) != myFeatures[theFeatureID].end()) {
  33     //Events_Error::send(std::string("Validator ") + theID +
  34     //  " for feature " + theFeatureID + "is already registered");
  35   } else {
  36     myFeatures[theFeatureID][theID] = std::list<std::string>();
  37   }
  38 }
  39
  40 void Model_ValidatorsFactory::assignValidator(const std::string& theID,
  41   const std::string& theFeatureID,
  42   const std::list<std::string>& theArguments)
  43 {
  44   if (myFeatures.find(theFeatureID) == myFeatures.end()) {
  45     myFeatures[theFeatureID] = AttrValidators();
  46   }
  47
  48   if (myFeatures[theFeatureID].find(theID) != myFeatures[theFeatureID].end()) {
  49     //Events_Error::send(std::string("Validator ") + theID +
  50     //  " for feature " + theFeatureID + "is already registered");
  51   } else {
  52     myFeatures[theFeatureID][theID] = theArguments;
  53   }
  54 }
  55
  56 void Model_ValidatorsFactory::assignValidator(const std::string& theID,
  57   const std::string& theFeatureID,
  58   const std::string& theAttrID,
  59   const std::list<std::string>& theArguments)
  60 {
  61   // create feature-structures if not exist
  62   std::map<std::string, std::map<std::string, AttrValidators> >::iterator aFeature = myAttrs.find(
  63     theFeatureID);
  64   if (aFeature == myAttrs.end()) {
  65     myAttrs[theFeatureID] = std::map<std::string, AttrValidators>();
  66     aFeature = myAttrs.find(theFeatureID);
  67   }
  68   // add attr-structure if not exist, or generate error if already exist
  69   std::map<std::string, AttrValidators>::iterator anAttr = aFeature->second.find(theAttrID);
  70   if (anAttr == aFeature->second.end()) {
  71     aFeature->second[theAttrID] = AttrValidators();
  72   }
  73   aFeature->second[theAttrID][theID] = theArguments;
  74 }
  75
  76 void Model_ValidatorsFactory::validators(const std::string& theFeatureID,
  77   std::list<ModelAPI_Validator*>& theResult,
  78   std::list<std::list<std::string> >& theArguments) const
  79 {
  80   std::map<std::string, AttrValidators>::const_iterator aFeature = myFeatures.find(theFeatureID);
  81   if (aFeature != myFeatures.cend()) {
  82     AttrValidators::const_iterator aValIter = aFeature->second.cbegin();
  83     for (; aValIter != aFeature->second.cend(); aValIter++) {
  84       std::map<std::string, ModelAPI_Validator*>::const_iterator aFound =
  85         myIDs.find(aValIter->first);
  86       if (aFound == myIDs.end()) {
  87         Events_Error::send(std::string("Validator ") + aValIter->first + " was not registered");
  88       } else {
  89         theResult.push_back(aFound->second);
  90         theArguments.push_back(aValIter->second);
  91       }
  92     }
  93   }
  94   addDefaultValidators(theResult, theArguments);
  95 }
  96
  97 void Model_ValidatorsFactory::validators(const std::string& theFeatureID,
  98   const std::string& theAttrID,
  99   std::list<ModelAPI_Validator*>& theValidators,
 100   std::list<std::list<std::string> >& theArguments) const
 101 {
 102   std::map<std::string, std::map<std::string, AttrValidators> >::const_iterator aFeature =
 103     myAttrs.find(theFeatureID);
 104   if (aFeature != myAttrs.cend()) {
 105     std::map<std::string, AttrValidators>::const_iterator anAttr = aFeature->second.find(theAttrID);
 106     if (anAttr != aFeature->second.end()) {
 107       AttrValidators::const_iterator aValIter = anAttr->second.cbegin();
 108       for (; aValIter != anAttr->second.cend(); aValIter++) {
 109         std::map<std::string, ModelAPI_Validator*>::const_iterator aFound = myIDs.find(
 110           aValIter->first);
 111         if (aFound == myIDs.end()) {
 112           Events_Error::send(std::string("Validator ") + aValIter->first + " was not registered");
 113         } else {
 114           theValidators.push_back(aFound->second);
 115           theArguments.push_back(aValIter->second);
 116         }
 117       }
 118     }
 119   }
 120 }
 121
 122 Model_ValidatorsFactory::Model_ValidatorsFactory()
 123   : ModelAPI_ValidatorsFactory()
 124 {
 125   const static std::string kDefaultId = "Model_FeatureValidator";
 126   registerValidator(kDefaultId, new Model_FeatureValidator);
 127 }
 128
 129 const ModelAPI_Validator* Model_ValidatorsFactory::validator(const std::string& theID) const
 130 {
 131   std::map<std::string, ModelAPI_Validator*>::const_iterator aIt = myIDs.find(theID);
 132   if (aIt != myIDs.end()) {
 133     return aIt->second;
 134   }
 135   return NULL;
 136 }
 137
 138 void Model_ValidatorsFactory::addDefaultValidators(std::list<ModelAPI_Validator*>& theValidators,
 139   std::list<std::list<std::string> >& theArguments) const
 140 {
 141   const static std::string kDefaultId = "Model_FeatureValidator";
 142   std::map<std::string, ModelAPI_Validator*>::const_iterator it = myIDs.find(kDefaultId);
 143   if(it == myIDs.end())
 144     return;
 145   theValidators.push_back(it->second);
 146   theArguments.push_back(std::list<std::string>());
 147 }
 148
 149 bool Model_ValidatorsFactory::validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const
 150 {
 151   const static std::string kDefaultId = "Model_FeatureValidator";
 152   // check feature validators first
 153   std::map<std::string, AttrValidators>::const_iterator aFeature =
 154     myFeatures.find(theFeature->getKind());
 155   if (aFeature != myFeatures.end()) {
 156     AttrValidators::const_iterator aValidator = aFeature->second.begin();
 157     for(; aValidator != aFeature->second.end(); aValidator++) {
 158       std::map<std::string, ModelAPI_Validator*>::const_iterator aValFind =
 159         myIDs.find(aValidator->first);
 160       if (aValFind == myIDs.end()) {
 161         Events_Error::send(std::string("Validator ") + aValidator->first + " was not registered");
 162         continue;
 163       }
 164       const ModelAPI_FeatureValidator* aFValidator =
 165         dynamic_cast<const ModelAPI_FeatureValidator*>(aValFind->second);
 166       if (aFValidator) {
 167         if (!aFValidator->isValid(theFeature, aValidator->second))
 168           return false;
 169       }
 170     }
 171   }
 172   // check default validator
 173   std::map<std::string, ModelAPI_Validator*>::const_iterator aDefaultVal = myIDs.find(kDefaultId);
 174   if(aDefaultVal != myIDs.end()) {
 175     static const std::list<std::string> anEmptyArgList;
 176     const ModelAPI_FeatureValidator* aFValidator =
 177       dynamic_cast<const ModelAPI_FeatureValidator*>(aDefaultVal->second);
 178     if (aFValidator) {
 179       if (!aFValidator->isValid(theFeature, anEmptyArgList))
 180         return false;
 181     }
 182   }
 183
 184   // check all attributes for validity
 185   std::shared_ptr<ModelAPI_Data> aData = theFeature->data();
 186   // Validity of data is checked by "Model_FeatureValidator" (kDefaultId)
 187   // if (!aData || !aData->isValid())
 188   //   return false;
 189   static const std::string kAllTypes = "";
 190   std::map<std::string, std::map<std::string, AttrValidators> >::const_iterator aFeatureIter =
 191     myAttrs.find(theFeature->getKind());
 192   if (aFeatureIter != myAttrs.cend()) {
 193     std::list<std::string> aLtAttributes = aData->attributesIDs(kAllTypes);
 194     std::list<std::string>::iterator anAttrIter = aLtAttributes.begin();
 195     for (; anAttrIter != aLtAttributes.end(); anAttrIter++) {
 196       std::map<std::string, AttrValidators>::const_iterator anAttr =
 197           aFeatureIter->second.find(*anAttrIter);
 198       if (anAttr != aFeatureIter->second.end()) {
 199         // skip not-case attributres, that really may be invalid (issue 671)
 200         if (!const_cast<Model_ValidatorsFactory*>(this)->isCase(theFeature, anAttr->first))
 201           continue;
 202         AttrValidators::const_iterator aValIter = anAttr->second.cbegin();
 203         for (; aValIter != anAttr->second.cend(); aValIter++) {
 204           std::map<std::string, ModelAPI_Validator*>::const_iterator aFound = myIDs.find(
 205             aValIter->first);
 206           if (aFound == myIDs.end()) {
 207             Events_Error::send(std::string("Validator ") + aValIter->first + " was not registered");
 208           } else {
 209             const ModelAPI_AttributeValidator* anAttrValidator =
 210               dynamic_cast<const ModelAPI_AttributeValidator*>(aFound->second);
 211             if (anAttrValidator) {
 212               AttributePtr anAttribute = theFeature->data()->attribute(*anAttrIter);
 213               if (!anAttrValidator->isValid(anAttribute, aValIter->second)) {
 214                   return false;
 215               }
 216             }
 217           }
 218         }
 219       }
 220     }
 221   }
 222   return true;
 223 }
 224
 225 void Model_ValidatorsFactory::registerNotObligatory(std::string theFeature, std::string theAttribute)
 226 {
 227   const static std::string kDefaultId = "Model_FeatureValidator";
 228   std::map<std::string, ModelAPI_Validator*>::const_iterator it = myIDs.find(kDefaultId);
 229   if (it != myIDs.end()) {
 230     Model_FeatureValidator* aValidator = dynamic_cast<Model_FeatureValidator*>(it->second);
 231     if (aValidator) {
 232       aValidator->registerNotObligatory(theFeature, theAttribute);
 233     }
 234   }
 235 }
 236
 237 bool Model_ValidatorsFactory::isNotObligatory(std::string theFeature, std::string theAttribute)
 238 {
 239   const static std::string kDefaultId = "Model_FeatureValidator";
 240   std::map<std::string, ModelAPI_Validator*>::const_iterator it = myIDs.find(kDefaultId);
 241   if (it != myIDs.end()) {
 242     Model_FeatureValidator* aValidator = dynamic_cast<Model_FeatureValidator*>(it->second);
 243     if (aValidator) {
 244       return aValidator->isNotObligatory(theFeature, theAttribute);
 245     }
 246   }
 247   return false; // default
 248 }
 249
 250 void Model_ValidatorsFactory::registerConcealment(std::string theFeature, std::string theAttribute)
 251 {
 252   std::map<std::string, std::set<std::string> >::iterator aFind = myConcealed.find(theFeature);
 253   if (aFind == myConcealed.end()) {
 254     std::set<std::string> aNewSet;
 255     aNewSet.insert(theAttribute);
 256     myConcealed[theFeature] = aNewSet;
 257   } else {
 258     aFind->second.insert(theAttribute);
 259   }
 260 }
 261
 262 bool Model_ValidatorsFactory::isConcealed(std::string theFeature, std::string theAttribute)
 263 {
 264   std::map<std::string, std::set<std::string> >::iterator aFind = myConcealed.find(theFeature);
 265   return aFind != myConcealed.end() && aFind->second.find(theAttribute) != aFind->second.end();
 266 }
 267
 268 void Model_ValidatorsFactory::registerCase(std::string theFeature, std::string theAttribute,
 269     std::string theSwitchId, std::string theCaseId)
 270 {
 271   std::map<std::string, std::map<std::string, std::pair<std::string, std::string> > >::iterator
 272     aFindFeature = myCases.find(theFeature);
 273   if (aFindFeature == myCases.end()) {
 274     myCases[theFeature] = std::map<std::string, std::pair<std::string, std::string> >();
 275     aFindFeature = myCases.find(theFeature);
 276   }
 277   (aFindFeature->second)[theAttribute] = std::pair<std::string, std::string>(theSwitchId, theCaseId);
 278 }
 279
 280 bool Model_ValidatorsFactory::isCase(
 281   FeaturePtr theFeature, std::string theAttribute)
 282 {
 283   std::map<std::string, std::map<std::string, std::pair<std::string, std::string> > >::iterator
 284     aFindFeature = myCases.find(theFeature->getKind());
 285   if (aFindFeature != myCases.end()) {
 286     std::map<std::string, std::pair<std::string, std::string> >::iterator
 287       aFindAttr = aFindFeature->second.find(theAttribute);
 288     if (aFindAttr != aFindFeature->second.end()) {
 289       // the the switch-attribute that contains the case value
 290       AttributeStringPtr aSwitch = theFeature->string(aFindAttr->second.first);
 291       if (aSwitch.get()) {
 292         return aSwitch->value() == aFindAttr->second.second; // the second is the case identifier
 293       }
 294     }
 295   }
 296   return true; // if no additional conditions, this attribute is the case to be validated
 297 }