ACE/ACEXML/common/Validator.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Validator.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10 #ifndef _ACEXML_VALIDATOR_H_
  11 #define _ACEXML_VALIDATOR_H_
  12
  13 #include /**/ "ace/pre.h"
  14 #include "ACEXML/common/ACEXML_Export.h"
  15
  16 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  17 #pragma once
  18 #endif /* ACE_LACKS_PRAGMA_ONCE */
  19
  20 #include "ACEXML/common/Attributes.h"
  21 #include "ACEXML/common/SAXExceptions.h"
  22
  23 /**
  24  * @class ACEXML_Validator
  25  *
  26  * @brief An abstract virtual class defining validator interface.
  27  *
  28  * An validator provides validation service for one XML element.
  29  * ACEXML_Validators are stateful object.  Implementations should
  30  * remember the current element encountered and determine if
  31  * it's a valid sequence of child elements.  A parser fishes
  32  * out a validator of certain
  33  */
  34 class ACEXML_Export ACEXML_Validator
  35 {
  36 public:
  37   virtual ~ACEXML_Validator () = 0;
  38
  39   /**
  40    * Validate attributes of an element.
  41    *
  42    * @retval 0 if valid, -1 otherwise.
  43    */
  44   virtual int startElement (ACEXML_Attributes *atts) = 0;
  45
  46   /**
  47    * Validate the next child element.
  48    *
  49    * @retval 0 if valid, -1 otherwise.
  50    */
  51   virtual int nextElement (const ACEXML_Char *namespaceURI,
  52                             const ACEXML_Char *localName,
  53                             const ACEXML_Char *qName) = 0;
  54 };
  55
  56
  57 #include /**/ "ace/post.h"
  58
  59 #endif /* _ACEXML_VALIDATOR_H_ */