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

xml/soap/webservice

开发平台:

C/C++

  1. #ifndef IDOM_Attr_HEADER_GUARD_
  2. #define IDOM_Attr_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 2001, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Log: IDOM_Attr.hpp,v $
  60.  * Revision 1.2  2001/05/11 13:25:48  tng
  61.  * Copyright update.
  62.  *
  63.  * Revision 1.1.1.1  2001/04/03 00:14:27  andyh
  64.  * IDOM
  65.  *
  66.  */
  67. #include <util/XercesDefs.hpp>
  68. #include "IDOM_Node.hpp"
  69. class IDOM_Element;
  70. /**
  71. * The <code>IDOM_Attr</code> class refers to an attribute of an XML element.
  72. *
  73. * Typically the allowable values for the
  74. * attribute are defined in a documenttype definition.
  75. * <p><code>IDOM_Attr</code> objects inherit the <code>DOM_Node</code>  interface, but
  76. * since attributes are not actually child nodes of the elements they are associated with, the
  77. * DOM does not consider them part of the document  tree.  Thus, the
  78. * <code>DOM_Node</code> attributes <code>parentNode</code>,
  79. * <code>previousSibling</code>, and <code>nextSibling</code> have a  null
  80. * value for <code>IDOM_Attr</code> objects. The DOM takes the  view that
  81. * attributes are properties of elements rather than having a  separate
  82. * identity from the elements they are associated with;  this should make it
  83. * more efficient to implement such features as default attributes associated
  84. * with all elements of a  given type.  Furthermore, attribute nodes
  85. * may not be immediate children of a <code>DocumentFragment</code>. However,
  86. * they can be associated with <code>Element</code> nodes contained within a
  87. * <code>DocumentFragment</code>. In short, users of the DOM
  88. * need to be aware that  <code>Attr</code> nodes have some things in  common
  89. * with other objects inheriting the <code>Node</code> interface, but they
  90. * also are quite distinct.
  91. *
  92. */
  93. class CDOM_EXPORT IDOM_Attr: public IDOM_Node {
  94. protected:
  95.     IDOM_Attr() {};
  96.     IDOM_Attr(const IDOM_Attr &other) {};
  97.     IDOM_Attr & operator = (const IDOM_Attr &other) {return *this;};
  98. public:
  99.   /** @name Destructor */
  100.   //@{
  101.   /**
  102.     * Destructor.  The object being destroyed is a reference to the Attribute
  103.     * "node", not the underlying attribute itself.
  104.     *
  105.     */
  106.     virtual ~IDOM_Attr() {};
  107. //@}
  108.   /** @name Getter functions */
  109.   //@{
  110.     /**
  111.     * Returns the name of this attribute.
  112.     */
  113.     virtual const XMLCh *       getName() const = 0;
  114.     /**
  115.     *
  116.     * Returns true if the attribute received its value explicitly in the
  117.     * XML document, or if a value was assigned programatically with
  118.     * the setValue function.  Returns false if the attribute value
  119.     * came from the default value declared in the document's DTD.
  120.     */
  121.     virtual bool            getSpecified() const = 0;
  122.     /**
  123. * Returns the value of the attribute.
  124. *
  125.     * The value of the attribute is returned as a string.
  126.     * Character and general entity references are replaced with their values.
  127.     */
  128.     virtual const XMLCh *       getValue() const = 0;
  129. //@}
  130.   /** @name Setter functions */
  131.   //@{
  132.     /**
  133. * Sets the value of the attribute.  A text node with the unparsed contents
  134.     * of the string will be created.
  135. *
  136.     * @param value The value of the DOM attribute to be set
  137.     */
  138.     virtual void            setValue(const XMLCh *value) = 0;
  139. //@}
  140.     /** @name Functions introduced in DOM Level 2. */
  141.     //@{
  142.     /**
  143.      * The <code>DOM_Element</code> node this attribute is attached to or
  144.      * <code>null</code> if this attribute is not in use.
  145.      *
  146.      * <p><b>"Experimental - subject to change"</b></p>
  147.      *
  148.      */
  149.     virtual IDOM_Element     *getOwnerElement() const = 0;
  150.     //@}
  151. };
  152. #endif