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

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 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: DOM_Entity.hpp,v $
  58.  * Revision 1.8  2000/09/09 00:11:46  andyh
  59.  * Virtual Destructor Patch, submitted by Kirk Wylie
  60.  *
  61.  * Revision 1.7  2000/04/19 02:26:16  aruna1
  62.  * Full support for DOM_EntityReference, DOM_Entity and DOM_DocumentType introduced
  63.  *
  64.  * Revision 1.6  2000/03/11 02:58:38  chchou
  65.  * Fix bug # 18, remove set method of readonly attributes
  66.  *
  67.  * Revision 1.5  2000/03/02 19:53:55  roddey
  68.  * This checkin includes many changes done while waiting for the
  69.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  70.  * available elsewhere.
  71.  *
  72.  * Revision 1.4  2000/02/24 20:11:28  abagchi
  73.  * Swat for removing Log from API docs
  74.  *
  75.  * Revision 1.3  2000/02/06 07:47:30  rahulj
  76.  * Year 2K copyright swat.
  77.  *
  78.  * Revision 1.2  2000/01/05 01:16:07  andyh
  79.  * DOM Level 2 core, namespace support added.
  80.  *
  81.  * Revision 1.1.1.1  1999/11/09 01:08:58  twl
  82.  * Initial checkin
  83.  *
  84.  * Revision 1.2  1999/11/08 20:44:17  rahul
  85.  * Swat for adding in Product name and CVS comment log variable.
  86.  *
  87.  */
  88. #ifndef DOM_Entity_HEADER_GUARD_
  89. #define DOM_Entity_HEADER_GUARD_
  90. #include <util/XercesDefs.hpp>
  91. #include <dom/DOM_Node.hpp>
  92. class EntityImpl;
  93. /**
  94.  * This interface represents an entity, either parsed or unparsed, in an XML 
  95.  * document. 
  96.  *
  97.  * Note that this models the entity itself not the entity 
  98.  * declaration. <code>Entity</code> declaration modeling has been left for a 
  99.  * later Level of the DOM specification.
  100.  * <p>The <code>nodeName</code> attribute that is inherited from 
  101.  * <code>Node</code> contains the name of the entity.
  102.  * <p>An XML processor may choose to completely expand entities before  the 
  103.  * structure model is passed to the DOM; in this case there will be no 
  104.  * <code>EntityReference</code> nodes in the document tree.
  105.  *
  106.  * <p>Note: the first release of this parser does not create entity
  107.  *    nodes when reading an XML document.  Entities may be
  108.  *    programatically created using DOM_Document::createEntity().
  109.  */
  110. class CDOM_EXPORT DOM_Entity: public DOM_Node {
  111. public:
  112.     /** @name Constructors and assignment operator */
  113.     //@{
  114.     /**
  115.       * Default constructor for DOM_Entity.
  116.       *
  117.       */
  118.     DOM_Entity();
  119.     /**
  120.       * Copy constructor.
  121.       *
  122.       * @param other The object to be copied.
  123.       */
  124.     DOM_Entity(const DOM_Entity &other);
  125.     /**
  126.       * Assignment operator.
  127.       *
  128.       * @param other The object to be copied.
  129.       */
  130.     DOM_Entity & operator = (const DOM_Entity &other);
  131.     /**
  132.       * Assignment operator.  This overloaded variant is provided for
  133.       *   the sole purpose of setting a DOM_Node reference variable to
  134.       *   zero.  Nulling out a reference variable in this way will decrement
  135.       *   the reference count on the underlying Node object that the variable
  136.       *   formerly referenced.  This effect is normally obtained when reference
  137.       *   variable goes out of scope, but zeroing them can be useful for
  138.       *   global instances, or for local instances that will remain in scope
  139.       *   for an extended time,  when the storage belonging to the underlying
  140.       *   node needs to be reclaimed.
  141.       *
  142.       * @param val.  Only a value of 0, or null, is allowed.
  143.       */
  144.     DOM_Entity & operator = (const DOM_NullPtr *val);
  145.     //@}
  146.     /** @name Destructor. */
  147.     //@{
  148.  /**
  149.   * Destructor for DOM_Entity.
  150.   *
  151.   */
  152.     ~DOM_Entity();
  153.     //@}
  154.     /** @name Get functions. */
  155.     //@{
  156.   /**
  157.    * The public identifier associated with the entity, if specified. 
  158.    *
  159.    * If the public identifier was not specified, this is <code>null</code>.
  160.    */
  161.   DOMString        getPublicId() const;
  162.   /**
  163.    * The system identifier associated with the entity, if specified. 
  164.    *
  165.    * If the system identifier was not specified, this is <code>null</code>.
  166.    */
  167.   DOMString        getSystemId() const;
  168.   /**
  169.    * For unparsed entities, the name of the notation for the entity. 
  170.    *
  171.    * For parsed entities, this is <code>null</code>. 
  172.    */
  173.   DOMString        getNotationName() const;
  174.   DOM_Node getFirstChild() const;
  175.   DOM_Node      getLastChild() const;
  176.   DOM_NodeList  getChildNodes() const;
  177.   bool          hasChildNodes() const;
  178.   DOM_Node getPreviousSibling() const;
  179.   DOM_Node getNextSibling() const;
  180.   //@}
  181. protected:
  182.     DOM_Entity(EntityImpl *impl);
  183.     friend class DOM_Document;
  184. };
  185. #endif