DOM_Notation.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_Notation.hpp,v $
  58.  * Revision 1.6  2000/03/11 02:58:39  chchou
  59.  * Fix bug # 18, remove set method of readonly attributes
  60.  *
  61.  * Revision 1.5  2000/03/02 19:53:57  roddey
  62.  * This checkin includes many changes done while waiting for the
  63.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  64.  * available elsewhere.
  65.  *
  66.  * Revision 1.4  2000/02/24 20:11:28  abagchi
  67.  * Swat for removing Log from API docs
  68.  *
  69.  * Revision 1.3  2000/02/06 07:47:31  rahulj
  70.  * Year 2K copyright swat.
  71.  *
  72.  * Revision 1.2  2000/01/05 01:16:08  andyh
  73.  * DOM Level 2 core, namespace support added.
  74.  *
  75.  * Revision 1.1.1.1  1999/11/09 01:09:03  twl
  76.  * Initial checkin
  77.  *
  78.  * Revision 1.2  1999/11/08 20:44:21  rahul
  79.  * Swat for adding in Product name and CVS comment log variable.
  80.  *
  81.  */
  82. #ifndef DOM_Notation_HEADER_GUARD_
  83. #define DOM_Notation_HEADER_GUARD_
  84. #include <util/XercesDefs.hpp>
  85. #include <dom/DOM_Node.hpp>
  86. class NotationImpl;
  87. /**
  88.  * This interface represents a notation declared in the DTD. A notation either 
  89.  * declares, by name, the format of an unparsed entity (see section 4.7 of 
  90.  * the XML 1.0 specification), or is used for formal declaration of 
  91.  * Processing Instruction targets (see section 2.6 of the XML 1.0 
  92.  * specification). The <code>nodeName</code> attribute inherited from 
  93.  * <code>Node</code> is set to the declared name of the notation.
  94.  * <p>The DOM Level 1 does not support editing <code>Notation</code> nodes; 
  95.  * they are therefore readonly.
  96.  * <p>A <code>Notation</code> node does not have any parent.
  97.  */
  98. class CDOM_EXPORT DOM_Notation: public DOM_Node {
  99. public:
  100.     /** @name Constructors and assignment operator */
  101.     //@{
  102.     /**
  103.       * Default constructor for DOM_Notation.  The resulting object does not
  104.     * refer to an actual Notation node; it will compare == to 0, and is similar
  105.     * to a null object reference variable in Java.  It may subsequently be
  106.     * assigned to refer to an actual Notation node.
  107.     * <p>
  108.     * New notation nodes are created by DOM_Document::createNotation().
  109.     *
  110.       *
  111.       */
  112.     DOM_Notation();
  113.     /**
  114.       * Copy constructor.  Creates a new <code>DOM_Notation</code> that refers to the
  115.       * same underlying node as the original.  See also DOM_Node::clone(),
  116.       * which will copy the actual notation node, rather than just creating a new
  117.       * reference to the original node.
  118.       *
  119.       * @param other The object to be copied.
  120.       */
  121.     DOM_Notation(const DOM_Notation &other);
  122.     /**
  123.       * Assignment operator.
  124.       *
  125.       * @param other The object to be copied.
  126.       */
  127.     DOM_Notation & operator = (const DOM_Notation &other);
  128.      /**
  129.       * Assignment operator.  This overloaded variant is provided for
  130.       *   the sole purpose of setting a DOM_Node reference variable to
  131.       *   zero.  Nulling out a reference variable in this way will decrement
  132.       *   the reference count on the underlying Node object that the variable
  133.       *   formerly referenced.  This effect is normally obtained when reference
  134.       *   variable goes out of scope, but zeroing them can be useful for
  135.       *   global instances, or for local instances that will remain in scope
  136.       *   for an extended time,  when the storage belonging to the underlying
  137.       *   node needs to be reclaimed.
  138.       *
  139.       * @param val.  Only a value of 0, or null, is allowed.
  140.       */
  141.     DOM_Notation & operator = (const DOM_NullPtr *val);
  142.     //@}
  143.     /** @name Destructor. */
  144.     //@{
  145.  /**
  146.   * Destructor for DOM_Notation.  The object being destroyed is the reference
  147.       * object, not the underlying Notation node itself.
  148.       * 
  149.   */
  150.     ~DOM_Notation();
  151.     //@}
  152.     /** @name Get functions. */
  153.     //@{
  154.     /**
  155.      * Get the public identifier of this notation. 
  156.      * 
  157.      * If the  public identifier was not 
  158.      * specified, this is <code>null</code>.
  159.      * @return Returns the public identifier of the notation
  160.      */
  161.     DOMString        getPublicId() const;
  162.     /**
  163.      * Get the system identifier of this notation. 
  164.      *
  165.      * If the  system identifier was not 
  166.      * specified, this is <code>null</code>.
  167.      * @return Returns the system identifier of the notation
  168.      */
  169.     DOMString        getSystemId() const;
  170.     //@}
  171. protected:
  172.     DOM_Notation(NotationImpl *impl);
  173.     friend class DOM_Document;
  174. };
  175. #endif