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

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_Attr.hpp,v $
  58.  * Revision 1.7  2000/03/11 02:58:38  chchou
  59.  * Fix bug # 18, remove set method of readonly attributes
  60.  *
  61.  * Revision 1.6  2000/03/02 19:53:52  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.5  2000/02/24 20:11:27  abagchi
  67.  * Swat for removing Log from API docs
  68.  *
  69.  * Revision 1.4  2000/02/17 17:47:24  andyh
  70.  * Update Doc++ API comments
  71.  * NameSpace update to track W3C
  72.  * Changes were made by Chih Hsiang Chou
  73.  *
  74.  * Revision 1.3  2000/02/06 07:47:27  rahulj
  75.  * Year 2K copyright swat.
  76.  *
  77.  * Revision 1.2  2000/01/05 01:16:06  andyh
  78.  * DOM Level 2 core, namespace support added.
  79.  *
  80.  * Revision 1.1.1.1  1999/11/09 01:08:48  twl
  81.  * Initial checkin
  82.  *
  83.  * Revision 1.3  1999/11/08 20:44:13  rahul
  84.  * Swat for adding in Product name and CVS comment log variable.
  85.  *
  86.  */
  87. #ifndef DOM_Attr_HEADER_GUARD_
  88. #define DOM_Attr_HEADER_GUARD_
  89. #include <util/XercesDefs.hpp>
  90. #include <dom/DOM_Node.hpp>
  91. #include <dom/DOM_Element.hpp>
  92. class AttrImpl;
  93. /**
  94. * The <code>DOM_Attr</code> class refers to an attribute of an XML element.
  95. *
  96. * Typically the allowable values for the 
  97. * attribute are defined in a documenttype definition.
  98. * <p><code>DOM_Attr</code> objects inherit the <code>DOM_Node</code>  interface, but 
  99. * since attributes are not actually child nodes of the elements they are associated with, the 
  100. * DOM does not consider them part of the document  tree.  Thus, the 
  101. * <code>DOM_Node</code> attributes <code>parentNode</code>,  
  102. * <code>previousSibling</code>, and <code>nextSibling</code> have a  null 
  103. * value for <code>DOM_Attr</code> objects. The DOM takes the  view that 
  104. * attributes are properties of elements rather than having a  separate 
  105. * identity from the elements they are associated with;  this should make it 
  106. * more efficient to implement such features as default attributes associated 
  107. * with all elements of a  given type.  Furthermore, attribute nodes 
  108. * may not be immediate children of a <code>DocumentFragment</code>. However, 
  109. * they can be associated with <code>Element</code> nodes contained within a 
  110. * <code>DocumentFragment</code>. In short, users of the DOM 
  111. * need to be aware that  <code>Attr</code> nodes have some things in  common 
  112. * with other objects inheriting the <code>Node</code> interface, but they 
  113. * also are quite distinct.
  114. *  
  115. */
  116. class CDOM_EXPORT DOM_Attr: public DOM_Node {
  117.     
  118. public:
  119.   /** @name Constructors and assignment operators */
  120.   //@{
  121.   /**
  122.     * Default constructor for DOM_Attr.  The resulting object does not
  123.     * refer to any Attribute; it will compare == to 0, and is similar
  124.     * to a null object reference variable in Java.
  125.     *
  126.     */
  127.     DOM_Attr();
  128. public:
  129.   /**
  130.     * Copy constructor.  Creates a new <code>DOM_Attr</code> that refers to the
  131.     *   same underlying Attribute as the original.  See also DOM_Node::clone(),
  132.     * which will copy an actual attribute, rather than just creating a new
  133.     * reference to the original attribute.
  134.     *
  135.     * @param other The source attribute reference object
  136.     */
  137.     DOM_Attr(const DOM_Attr &other);
  138.   /**
  139.     * Assignment operator
  140.     *
  141.     * @param other The source attribute object
  142.     */
  143.     DOM_Attr & operator = (const DOM_Attr &other);
  144.     
  145.     /**
  146.       * Assignment operator.  This overloaded variant is provided for
  147.       *   the sole purpose of setting a DOM_Node reference variable to
  148.       *   zero.  Nulling out a reference variable in this way will decrement
  149.       *   the reference count on the underlying Node object that the variable
  150.       *   formerly referenced.  This effect is normally obtained when reference
  151.       *   variable goes out of scope, but zeroing them can be useful for
  152.       *   global instances, or for local instances that will remain in scope
  153.       *   for an extended time,  when the storage belonging to the underlying
  154.       *   node needs to be reclaimed.
  155.       *
  156.       * @param val.  Only a value of 0, or null, is allowed.
  157.       */
  158.     DOM_Attr & operator = (const DOM_NullPtr *val);
  159. //@}
  160.   /** @name Destructor */
  161.   //@{
  162.     
  163.   /**
  164.     * Destructor.  The object being destroyed is a reference to the Attribute
  165.     * "node", not the underlying attribute itself.
  166.     *
  167.     */
  168.     ~DOM_Attr();
  169. //@}
  170.     
  171.   /** @name Getter functions */
  172.   //@{
  173.     /**
  174.     * Returns the name of this attribute. 
  175.     */
  176.     DOMString       getName() const;
  177.     /**
  178.     *
  179.     * Returns true if the attribute received its value explicitly in the
  180.     * XML document, or if a value was assigned programatically with
  181.     * the setValue function.  Returns false if the attribute value 
  182.     * came from the default value declared in the document's DTD.
  183.     */
  184.     bool            getSpecified() const;
  185.     /**
  186. * Returns the value of the attribute.
  187. *
  188.     * The value of the attribute is returned as a string. 
  189.     * Character and general entity references are replaced with their values.
  190.     */
  191.     DOMString       getValue() const;
  192.     
  193. //@}
  194.   /** @name Setter functions */
  195.   //@{
  196.     /**
  197. * Sets the value of the attribute.  A text node with the unparsed contents
  198.     * of the string will be created.
  199. *
  200.     * @param value The value of the DOM attribute to be set
  201.     */
  202.     void            setValue(const DOMString &value);
  203. //@}
  204.     /** @name Functions introduced in DOM Level 2. */
  205.     //@{
  206.     /**
  207.      * The <code>DOM_Element</code> node this attribute is attached to or
  208.      * <code>null</code> if this attribute is not in use.
  209.      *
  210.      * <p><b>"Experimental - subject to change"</b></p>
  211.      *
  212.      */
  213.     DOM_Element     getOwnerElement() const;
  214.     //@}
  215. protected:
  216.     DOM_Attr(AttrImpl *attr);
  217.     friend class DOM_Element;
  218.     friend class DOM_Document;
  219. };
  220. #endif