src/FlightCrew/Validators/AttributesPresentValidator.h

   1 /************************************************************************\r
   2 **\r
   3 **  Copyright (C) 2010  Strahinja Markovic\r
   4 **\r
   5 **  This file is part of FlightCrew.\r
   6 **\r
   7 **  FlightCrew is free software: you can redistribute it and/or modify\r
   8 **  it under the terms of the GNU Lesser General Public License as published\r
   9 **  by the Free Software Foundation, either version 3 of the License, or\r
  10 **  (at your option) any later version.\r
  11 **\r
  12 **  FlightCrew is distributed in the hope that it will be useful,\r
  13 **  but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  14 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  15 **  GNU Lesser General Public License for more details.\r
  16 **\r
  17 **  You should have received a copy of the GNU Lesser General Public License\r
  18 **  along with FlightCrew.  If not, see <http://www.gnu.org/licenses/>.\r
  19 **\r
  20 *************************************************************************/\r
  21 \r
  22 #pragma once\r
  23 #ifndef ATTRIBUTESPRESENTVALIDATOR_H\r
  24 #define ATTRIBUTESPRESENTVALIDATOR_H\r
  25 \r
  26 #include "XmlValidator.h"\r
  27 #include <QName.h>\r
  28 \r
  29 namespace xe = XercesExt;\r
  30 \r
  31 namespace FlightCrew\r
  32 {\r
  33 \r
  34 class AttributesPresentValidator : public XmlValidator\r
  35 {\r
  36 \r
  37 protected:\r
  38     \r
  39     /**\r
  40      * Checks that the attributes of all the elements matching the given name\r
  41      * are allowed.\r
  42      *\r
  43      * @param element_qname The name of the element whose attributes we want to check.\r
  44      * @param attribute_qnames A list of allowed attributes.\r
  45      * @param document The document being validated.\r
  46      * @return A list of validation results, empty if no problem were found.\r
  47      */\r
  48     std::vector< Result > HasOnlyAllowedAttributes( const xe::QName &element_qname,\r
  49                                                     const std::vector< xe::QName > &attribute_qnames,\r
  50                                                     const xc::DOMDocument &document );\r
  51 \r
  52     /**\r
  53      * Checks that all the elements matching the given name have all their\r
  54      * mandatory attributes.\r
  55      *\r
  56      * @param element_qname The name of the element whose attributes we want to check.\r
  57      * @param attribute_qnames A list of mandatory attributes.\r
  58      * @param document The document being validated.\r
  59      * @return A list of validation results, empty if no problem were found.\r
  60      */\r
  61     std::vector< Result > HasMandatoryAttributes( const xe::QName &element_qname,\r
  62                                                   const std::vector< xe::QName > &attribute_qnames,\r
  63                                                   const xc::DOMDocument &document );\r
  64 \r
  65 private:\r
  66 \r
  67     bool IsAllowedAttribute( const xc::DOMAttr &attribute,\r
  68                              const std::vector< xe::QName > &allowed_attribute_qnames );\r
  69 };\r
  70 \r
  71 } // namespace FlightCrew\r
  72 \r
  73 #endif // ATTRIBUTESPRESENTVALIDATOR_H