DTDElementDecl.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:11k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: DTDElementDecl.hpp,v $
  58.  * Revision 1.12  2001/09/05 20:49:10  knoaman
  59.  * Fix for complexTypes with mixed content model.
  60.  *
  61.  * Revision 1.11  2001/08/21 16:06:11  tng
  62.  * Schema: Unique Particle Attribution Constraint Checking.
  63.  *
  64.  * Revision 1.10  2001/05/11 13:27:08  tng
  65.  * Copyright update.
  66.  *
  67.  * Revision 1.9  2001/04/19 18:17:20  tng
  68.  * Schema: SchemaValidator update, and use QName in Content Model
  69.  *
  70.  * Revision 1.8  2001/03/21 21:56:19  tng
  71.  * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
  72.  *
  73.  * Revision 1.7  2001/03/21 19:29:43  tng
  74.  * Schema: Content Model Updates, by Pei Yong Zhang.
  75.  *
  76.  * Revision 1.6  2001/02/26 19:29:21  tng
  77.  * Schema: add virtual method getURI(), getContentSpec and setContenSpec in XMLElementDecl, and DTDElementDecl.
  78.  *
  79.  * Revision 1.5  2001/02/26 19:22:02  tng
  80.  * Schema: add parameter prefix in findElem and findAttr.
  81.  *
  82.  * Revision 1.4  2000/02/24 20:16:49  abagchi
  83.  * Swat for removing Log from API docs
  84.  *
  85.  * Revision 1.3  2000/02/09 21:42:37  abagchi
  86.  * Copyright swat
  87.  *
  88.  * Revision 1.2  1999/11/23 01:51:04  rahulj
  89.  * Cannot use class qualifier in class defn. CC under HPUX is happy.
  90.  *
  91.  * Revision 1.1.1.1  1999/11/09 01:03:32  twl
  92.  * Initial checkin
  93.  *
  94.  * Revision 1.3  1999/11/08 20:45:40  rahul
  95.  * Swat for adding in Product name and CVS comment log variable.
  96.  *
  97.  */
  98. #if !defined(DTDELEMENTDECL_HPP)
  99. #define DTDELEMENTDECL_HPP
  100. #include <util/RefHashTableOf.hpp>
  101. #include <util/QName.hpp>
  102. #include <framework/XMLElementDecl.hpp>
  103. #include <framework/XMLContentModel.hpp>
  104. #include <validators/DTD/DTDAttDef.hpp>
  105. class ContentSpecNode;
  106. class DTDAttDefList;
  107. //
  108. //  This class is a derivative of the basic element decl. This one implements
  109. //  the virtuals so that they work for a DTD. THe big difference is that
  110. //  they don't live in any URL in the DTD. The names are just stored as full
  111. //  QNames, so they are not split out and element decls don't live within
  112. //  URL namespaces or anything like that.
  113. //
  114. class VALIDATORS_EXPORT DTDElementDecl : public XMLElementDecl
  115. {
  116. public :
  117.     // -----------------------------------------------------------------------
  118.     //  Class specific types
  119.     //
  120.     //  ModelTypes
  121.     //      Indicates the type of content model that an element has. This
  122.     //      indicates how the content model is represented and validated.
  123.     // -----------------------------------------------------------------------
  124.     enum ModelTypes
  125.     {
  126.         Empty
  127.         , Any
  128.         , Mixed_Simple
  129.         , Children
  130.         , ModelTypes_Count
  131.     };
  132.     // -----------------------------------------------------------------------
  133.     //  Constructors and Destructor
  134.     // -----------------------------------------------------------------------
  135.     DTDElementDecl();
  136.     DTDElementDecl
  137.     (
  138.         const XMLCh* const    elemRawName
  139.       , const unsigned int    uriId
  140.       , const ModelTypes      modelType = Any
  141.     );
  142.     DTDElementDecl
  143.     (
  144.         QName* const    elementName
  145.       , const ModelTypes      modelType = Any
  146.     );
  147.     ~DTDElementDecl();
  148.     // -----------------------------------------------------------------------
  149.     //  The virtual element decl interface
  150.     // -----------------------------------------------------------------------
  151.     virtual XMLAttDef* findAttr
  152.     (
  153.         const   XMLCh* const    qName
  154.         , const unsigned int    uriId
  155.         , const XMLCh* const    baseName
  156.         , const XMLCh* const    prefix
  157.         , const LookupOpts      options
  158.         ,       bool&           wasAdded
  159.     )   const;
  160.     virtual XMLAttDefList& getAttDefList() const;
  161.     virtual CharDataOpts getCharDataOpts() const;
  162.     virtual bool hasAttDefs() const;
  163.     virtual bool resetDefs();
  164.     virtual const ContentSpecNode* getContentSpec() const;
  165.     virtual ContentSpecNode* getContentSpec();
  166.     virtual void setContentSpec(ContentSpecNode* toAdopt);
  167.     virtual XMLContentModel* getContentModel();
  168.     virtual void setContentModel(XMLContentModel* const newModelToAdopt);      
  169.     virtual const XMLCh* getFormattedContentModel ()   const;     
  170.     // -----------------------------------------------------------------------
  171.     // Support keyed collections
  172.     //
  173.     // This method allows objects of this type be placed into one of the
  174.     // standard keyed collections. This method will return the full name of
  175.     // the element, which will vary depending upon the type of the grammar.
  176.     // -----------------------------------------------------------------------
  177.     const XMLCh* getKey() const;
  178.     // -----------------------------------------------------------------------
  179.     //  Getter methods
  180.     // -----------------------------------------------------------------------
  181.     const DTDAttDef* getAttDef(const XMLCh* const attName) const;
  182.     DTDAttDef* getAttDef(const XMLCh* const attName);
  183.     ModelTypes getModelType() const;
  184.     // -----------------------------------------------------------------------
  185.     //  Setter methods
  186.     // -----------------------------------------------------------------------
  187.     void addAttDef(DTDAttDef* const toAdd);
  188.     void setModelType(const DTDElementDecl::ModelTypes toSet);
  189. private :
  190.     // -----------------------------------------------------------------------
  191.     //  Private helper methods
  192.     // -----------------------------------------------------------------------
  193.     void faultInAttDefList() const;    
  194.     XMLContentModel* createChildModel() ;
  195.     XMLContentModel* makeContentModel() ;
  196.     XMLCh* formatContentModel () const ;    
  197.     // -----------------------------------------------------------------------
  198.     //  Private data members
  199.     //
  200.     //  fAttDefs
  201.     //      The list of attributes that are defined for this element. Each
  202.     //      element is its own little 'namespace' for attributes, so each
  203.     //      element maintains its own list of owned attribute defs. It is
  204.     //      faulted in when an attribute is actually added.
  205.     //
  206.     //  fAttList
  207.     //      We have to return a view of our att defs via the abstract view
  208.     //      that the scanner understands. It may or may not ever be asked
  209.     //      for so we fault it in as needed.
  210.     //
  211.     //  fContentSpec
  212.     //      This is the content spec for the node. It contains the original
  213.     //      content spec that was read from the DTD, as a tree of nodes. This
  214.     //      one is always set up, and is used to build the fContentModel
  215.     //      version if we are validating.
  216.     //
  217.     //  fModelType
  218.     //      The content model type of this element. This tells us what kind
  219.     //      of content model to create.
  220.     //
  221.     //  fContentModel
  222.     //      The content model object for this element. It is stored here via
  223.     //      its abstract interface.    
  224.     //
  225.     //  fFormattedModel
  226.     //      This is a faulted in member. When the outside world asks for
  227.     //      our content model as a string, we format it and fault it into
  228.     //      this field (to avoid doing the formatted over and over.)    
  229.     // -----------------------------------------------------------------------
  230.     RefHashTableOf<DTDAttDef>*  fAttDefs;
  231.     DTDAttDefList*              fAttList;
  232.     ContentSpecNode*            fContentSpec;
  233.     ModelTypes                  fModelType;
  234.     XMLContentModel*            fContentModel;    
  235.     XMLCh*                      fFormattedModel;    
  236. };
  237. // ---------------------------------------------------------------------------
  238. //  DTDElementDecl: XMLElementDecl virtual interface implementation
  239. // ---------------------------------------------------------------------------
  240. inline ContentSpecNode* DTDElementDecl::getContentSpec()
  241. {
  242.     return fContentSpec;
  243. }
  244. inline const ContentSpecNode* DTDElementDecl::getContentSpec() const
  245. {
  246.     return fContentSpec;
  247. }
  248. inline XMLContentModel* DTDElementDecl::getContentModel()
  249. {
  250.     if (!fContentModel)
  251.         fContentModel = makeContentModel();
  252.     return fContentModel;
  253. }
  254. inline void
  255. DTDElementDecl::setContentModel(XMLContentModel* const newModelToAdopt)
  256. {
  257.     delete fContentModel;
  258.     fContentModel = newModelToAdopt;
  259. }
  260. // ---------------------------------------------------------------------------
  261. //  DTDElementDecl: Miscellaneous methods
  262. // ---------------------------------------------------------------------------
  263. inline const XMLCh* DTDElementDecl::getKey() const
  264. {
  265.     return getFullName();
  266. }
  267. // ---------------------------------------------------------------------------
  268. //  DTDElementDecl: Getter methods
  269. // ---------------------------------------------------------------------------
  270. inline DTDElementDecl::ModelTypes DTDElementDecl::getModelType() const
  271. {
  272.     return fModelType;
  273. }
  274. // ---------------------------------------------------------------------------
  275. //  DTDElementDecl: Setter methods
  276. // ---------------------------------------------------------------------------
  277. inline void
  278. DTDElementDecl::setModelType(const DTDElementDecl::ModelTypes toSet)
  279. {
  280.     fModelType = toSet;
  281. }
  282. #endif