src/ModelAPI/ModelAPI_Validator.h

   1 // File:        ModelAPI_Validator.hxx
   2 // Created:     2 Jul 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Validator_H_
   6 #define ModelAPI_Validator_H_
   7
   8 #include <ModelAPI.h>
   9 #include <boost/shared_ptr.hpp>
  10 #include <list>
  11
  12 class ModelAPI_Feature;
  13
  14 /**\class ModelAPI_Validator
  15  * \ingroup DataModel
  16  * \brief Allows to validate the attribute value of a feature or the whole feature.
  17  *
  18  * This object is assigned by the name
  19  * in the XML file to the specific attribute or to the whole feature.
  20  * If validator returns "false", it is signalized in user interface
  21  * and feature is not executed.
  22  * Validators must be registered in the validators factory to be
  23  * correctly identified by the XML string-ID.
  24  */
  25 class MODELAPI_EXPORT ModelAPI_Validator
  26 {
  27  public:
  28   // Make virtual destructor in order to make the class polymorphic
  29   virtual ~ModelAPI_Validator()
  30   {
  31   }
  32
  33   /// Returns true if feature and/or attributes are valid
  34   /// \param theFeature the validated feature
  35   /// \param theAttr the validated attribute ID, empty string of feature is validated
  36   /// \param theArguments list of string, feature attribute names: dependent attributes
  37   //virtual bool validate(const boost::shared_ptr<ModelAPI_Feature>& theFeature,
  38   //  const std::string theAttr, std::list<std::string> theArguments) const = 0;
  39 };
  40
  41 typedef boost::shared_ptr<ModelAPI_Validator> ValidatorPtr;
  42
  43 /**\class ModelAPI_ValidatorsFactory
  44  * \ingroup DataModel
  45  * \breif Manages the registered validators
  46  *
  47  * Allows to get a validator by the feature identifier and
  48  * the attribute identifier (if attribute is validated).
  49  * All accessible validators mustbe registered by the ID string first.
  50  * The instance of this factory can be get in the PluginManager.
  51  * Keeps the validator objects alive and just returns one of it by request.
  52  * All the needed information is provided to the validator as an argument,
  53  * this allows to work with them independently from the feature specific object.
  54  */
  55 class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
  56 {
  57  public:
  58   /// Registers the instance of the validator by the ID
  59   virtual void registerValidator(const std::string& theID, ModelAPI_Validator* theValidator) = 0;
  60
  61   /// Assigns validator to the feature
  62   virtual void assignValidator(const std::string& theID, const std::string& theFeatureID) = 0;
  63
  64   /// Assigns validator to the feature with arguments of the validator
  65   virtual void assignValidator(const std::string& theID,
  66                                             const std::string& theFeatureID,
  67                                             const std::list<std::string>& theArguments) = 0;
  68
  69   /// Assigns validator to the attribute of the feature
  70   virtual void assignValidator(const std::string& theID, const std::string& theFeatureID,
  71                                const std::string& theAttrID,
  72                                const std::list<std::string>& theArguments) = 0;
  73
  74   /// Provides a validator for the feature, returns NULL if no validator
  75   virtual void validators(const std::string& theFeatureID,
  76                           std::list<ModelAPI_Validator*>& theResult,
  77                           std::list<std::list<std::string> >& theArguments) const = 0;
  78   /// Provides a validator for the attribute, returns NULL if no validator
  79   virtual void validators(const std::string& theFeatureID, const std::string& theAttrID,
  80                           std::list<ModelAPI_Validator*>& theValidators,
  81                           std::list<std::list<std::string> >& theArguments) const = 0;
  82
  83   /// Returns registered validator by its Id
  84   virtual const ModelAPI_Validator* validator(const std::string& theID) const = 0;
  85
  86   /// Returns the result of "validate" method for attribute of validator.
  87   /// If validator is not exists, returns true: everything is valid by default.
  88   //virtual bool validate(
  89   //  const boost::shared_ptr<ModelAPI_Feature>& theFeature, const std::string& theAttrID) const = 0;
  90
  91  protected:
  92   /// Get instance from PluginManager
  93   ModelAPI_ValidatorsFactory()
  94   {
  95   }
  96 };
  97
  98 #endif