src/FlightCrew/Validators/ElementPresentValidator.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 ELEMENTPRESENTVALIDATOR_H\r
  24 #define ELEMENTPRESENTVALIDATOR_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 ElementPresentValidator : public XmlValidator\r
  35 {\r
  36 \r
  37 protected:\r
  38     \r
  39     /**\r
  40      * Verifies the presence of the element in the document.\r
  41      * We try to report the location of the error as the location\r
  42      * of a parent element that is supposed to contain the required element.\r
  43      * Since it's possible that the element can be a child of several\r
  44      * different parent types, a list is provided. The first parent \r
  45      * present is reported as the location of the error.\r
  46      *\r
  47      * @param element_qname The name of the element whose presence we want to check.\r
  48      * @param possible_parents A list of possible parent names.\r
  49      * @param document The document being validated.\r
  50      * @return A list of validation results.\r
  51      */\r
  52     std::vector< Result > VerifyElementPresent( const xe::QName &element_qname,\r
  53                                                 const std::vector< xe::QName > &possible_parents,\r
  54                                                 const xc::DOMDocument &document );\r
  55 };\r
  56 \r
  57 } // namespace FlightCrew\r
  58 \r
  59 #endif // ELEMENTPRESENTVALIDATOR_H