DOM_Attr.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:8k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2002 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.  * $Id: DOM_Attr.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_Attr_HEADER_GUARD_
  60. #define DOM_Attr_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_Node.hpp"
  63. #include "DOM_Element.hpp"
  64. XERCES_CPP_NAMESPACE_BEGIN
  65. class AttrImpl;
  66. /**
  67. * The <code>DOM_Attr</code> class refers to an attribute of an XML element.
  68. *
  69. * Typically the allowable values for the
  70. * attribute are defined in a documenttype definition.
  71. * <p><code>DOM_Attr</code> objects inherit the <code>DOM_Node</code>  interface, but
  72. * since attributes are not actually child nodes of the elements they are associated with, the
  73. * DOM does not consider them part of the document  tree.  Thus, the
  74. * <code>DOM_Node</code> attributes <code>parentNode</code>,
  75. * <code>previousSibling</code>, and <code>nextSibling</code> have a  null
  76. * value for <code>DOM_Attr</code> objects. The DOM takes the  view that
  77. * attributes are properties of elements rather than having a  separate
  78. * identity from the elements they are associated with;  this should make it
  79. * more efficient to implement such features as default attributes associated
  80. * with all elements of a  given type.  Furthermore, attribute nodes
  81. * may not be immediate children of a <code>DocumentFragment</code>. However,
  82. * they can be associated with <code>Element</code> nodes contained within a
  83. * <code>DocumentFragment</code>. In short, users of the DOM
  84. * need to be aware that  <code>Attr</code> nodes have some things in  common
  85. * with other objects inheriting the <code>Node</code> interface, but they
  86. * also are quite distinct.
  87. *
  88. */
  89. class CDOM_EXPORT DOM_Attr: public DOM_Node {
  90. public:
  91.   /** @name Constructors and assignment operators */
  92.   //@{
  93.   /**
  94.     * Default constructor for DOM_Attr.  The resulting object does not
  95.     * refer to any Attribute; it will compare == to 0, and is similar
  96.     * to a null object reference variable in Java.
  97.     *
  98.     */
  99.     DOM_Attr();
  100. public:
  101.   /**
  102.     * Copy constructor.  Creates a new <code>DOM_Attr</code> that refers to the
  103.     *   same underlying Attribute as the original.  See also DOM_Node::clone(),
  104.     * which will copy an actual attribute, rather than just creating a new
  105.     * reference to the original attribute.
  106.     *
  107.     * @param other The source attribute reference object
  108.     */
  109.     DOM_Attr(const DOM_Attr &other);
  110.   /**
  111.     * Assignment operator
  112.     *
  113.     * @param other The source attribute object
  114.     */
  115.     DOM_Attr & operator = (const DOM_Attr &other);
  116.     /**
  117.       * Assignment operator.  This overloaded variant is provided for
  118.       *   the sole purpose of setting a DOM_Node reference variable to
  119.       *   zero.  Nulling out a reference variable in this way will decrement
  120.       *   the reference count on the underlying Node object that the variable
  121.       *   formerly referenced.  This effect is normally obtained when reference
  122.       *   variable goes out of scope, but zeroing them can be useful for
  123.       *   global instances, or for local instances that will remain in scope
  124.       *   for an extended time,  when the storage belonging to the underlying
  125.       *   node needs to be reclaimed.
  126.       *
  127.       * @param val   Only a value of 0, or null, is allowed.
  128.       */
  129.     DOM_Attr & operator = (const DOM_NullPtr *val);
  130. //@}
  131.   /** @name Destructor */
  132.   //@{
  133.   /**
  134.     * Destructor.  The object being destroyed is a reference to the Attribute
  135.     * "node", not the underlying attribute itself.
  136.     *
  137.     */
  138.     ~DOM_Attr();
  139. //@}
  140.   /** @name Getter functions */
  141.   //@{
  142.     /**
  143.     * Returns the name of this attribute.
  144.     */
  145.     DOMString       getName() const;
  146.     /**
  147.     *
  148.     * Returns true if the attribute received its value explicitly in the
  149.     * XML document, or if a value was assigned programatically with
  150.     * the setValue function.  Returns false if the attribute value
  151.     * came from the default value declared in the document's DTD.
  152.     */
  153.     bool            getSpecified() const;
  154.     /**
  155. * Returns the value of the attribute.
  156. *
  157.     * The value of the attribute is returned as a string.
  158.     * Character and general entity references are replaced with their values.
  159.     */
  160.     DOMString       getValue() const;
  161. //@}
  162.   /** @name Setter functions */
  163.   //@{
  164.     /**
  165. * Sets the value of the attribute.  A text node with the unparsed contents
  166.     * of the string will be created.
  167. *
  168.     * @param value The value of the DOM attribute to be set
  169.     */
  170.     void            setValue(const DOMString &value);
  171. //@}
  172.     /** @name Functions introduced in DOM Level 2. */
  173.     //@{
  174.     /**
  175.      * The <code>DOM_Element</code> node this attribute is attached to or
  176.      * <code>null</code> if this attribute is not in use.
  177.      *
  178.      */
  179.     DOM_Element     getOwnerElement() const;
  180.     //@}
  181. protected:
  182.     DOM_Attr(AttrImpl *attr);
  183.     friend class DOM_Element;
  184.     friend class DOM_Document;
  185. };
  186. XERCES_CPP_NAMESPACE_END
  187. #endif