ACE/ACEXML/common/Element_Def_Builder.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Element_Def_Builder.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10 #ifndef _ACEXML_ELEMENT_DEF_BUILDER_H_
  11 #define _ACEXML_ELEMENT_DEF_BUILDER_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/XML_Types.h"
  21 #include "ACEXML/common/SAXExceptions.h"
  22 #include <memory>
  23
  24 /**
  25  * @class ACEXML_Element_Def_Builder
  26  *
  27  * @brief An abstract virtual class that defines the interface to define an
  28  * element definition.
  29  *
  30  * This class defines how to define an element definition after parsing a
  31  * DTD.
  32  */
  33 class ACEXML_Export ACEXML_Element_Def_Builder
  34 {
  35 public:
  36   typedef std::unique_ptr<ACEXML_Element_Def_Builder> VAR;
  37
  38   typedef enum {
  39     EMPTY,
  40     ANY,
  41     MIXED,
  42     CHILDREN,
  43     UNDEFINED
  44   } CONTENT_TYPE;
  45
  46   typedef enum {
  47     ONE,
  48     ZERO_OR_MORE,
  49     ONE_OR_MORE,
  50     ONE_OR_ZERO
  51   } CARDINALITY;
  52
  53   virtual ~ACEXML_Element_Def_Builder () = 0;
  54
  55   /**
  56    * Define the name of the element.
  57    *
  58    * @retval 0 if valid, -1 otherwise.
  59    */
  60   virtual int setElementName (const ACEXML_Char *namespaceURI,
  61                               const ACEXML_Char *localName,
  62                               const ACEXML_Char *qName) = 0;
  63
  64   /**
  65    * Define the content type of the element.
  66    *
  67    * @retval 0 if valid, -1 otherwise.
  68    */
  69   virtual int setContentType (CONTENT_TYPE type) = 0;
  70
  71   /**
  72    * Insert one more element into Mixed definition.
  73    */
  74   virtual int insertMixedElement (const ACEXML_Char *namespaceURI,
  75                                   const ACEXML_Char *localName,
  76                                   const ACEXML_Char *qName) = 0;
  77
  78   /**
  79    * Start a new group of children.
  80    */
  81   virtual int startChildGroup () = 0;
  82
  83   /**
  84    * End a new group of children.
  85    *
  86    * @retval 0 on success.
  87    */
  88   virtual int endChildGroup (CARDINALITY card) = 0;
  89
  90   /**
  91    * Set the type of current child group to Choice.
  92    *
  93    * @retval 0 on success, -1 if the type of the child group has
  94    * already been set and this action conflicts with the previous
  95    * setting.
  96    */
  97   virtual int setChoice () = 0;
  98
  99   /**
 100    * Set the type of current child group to Sequence.
 101    *
 102    * @retval 0 on success, -1 if the type of the child group has
 103    * already been set and this action conflicts with the previous
 104    * setting.
 105    */
 106   virtual int setSequence () = 0;
 107
 108   /**
 109    * Insert an new element into the current child group.
 110    *
 111    * @retval 0 on success, -1 otherwise.
 112    */
 113   virtual int insertElement  (const ACEXML_Char *namespaceURI,
 114                               const ACEXML_Char *localName,
 115                               const ACEXML_Char *qName) = 0;
 116
 117   /**
 118    * Dump the content of the attribute definition.
 119    */
 120   virtual void dump () = 0;
 121 };
 122
 123
 124 #include /**/ "ace/post.h"
 125
 126 #endif /* _ACEXML_ELEMENT_DEF_BUILDER_H_ */