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

词法分析

开发平台:

Visual C++

  1. #ifndef DOMAttr_HEADER_GUARD_
  2. #define DOMAttr_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001-2002 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.  * $Id: DOMAttr.hpp,v 1.8 2003/03/07 19:58:58 tng Exp $
  60.  */
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOMNode.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class DOMElement;
  65. class DOMTypeInfo;
  66. /**
  67.  * The <code>DOMAttr</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>DOMAttr</code> objects inherit the <code>DOMNode</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>DOMNode</code> attributes <code>parentNode</code>,
  75.  * <code>previousSibling</code>, and <code>nextSibling</code> have a  null
  76.  * value for <code>DOMAttr</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>DOMDocumentFragment</code>. However,
  82.  * they can be associated with <code>DOMElement</code> nodes contained within a
  83.  * <code>DOMDocumentFragment</code>. In short, users of the DOM
  84.  * need to be aware that  <code>DOMAttr</code> nodes have some things in  common
  85.  * with other objects inheriting the <code>DOMNode</code> interface, but they
  86.  * also are quite distinct.
  87.  *
  88.  * @since DOM Level 1
  89.  */
  90. class CDOM_EXPORT DOMAttr: public DOMNode {
  91. protected:
  92.     // -----------------------------------------------------------------------
  93.     //  Hidden constructors
  94.     // -----------------------------------------------------------------------
  95.     /** @name Hidden constructors */
  96.     //@{    
  97.     DOMAttr() {};
  98.     //@}
  99. private:    
  100.     // -----------------------------------------------------------------------
  101.     // Unimplemented constructors and operators
  102.     // -----------------------------------------------------------------------
  103.     /** @name Unimplemented constructors and operators */
  104.     //@{
  105.     DOMAttr(const DOMAttr &);
  106.     DOMAttr & operator = (const DOMAttr &);
  107.     //@}
  108. public:
  109.     // -----------------------------------------------------------------------
  110.     //  All constructors are hidden, just the destructor is available
  111.     // -----------------------------------------------------------------------
  112.     /** @name Destructor */
  113.     //@{
  114.     /**
  115.      * Destructor
  116.      *
  117.      */
  118.     virtual ~DOMAttr() {};
  119.     //@}
  120.     // -----------------------------------------------------------------------
  121.     //  Virtual DOMAttr interface
  122.     // -----------------------------------------------------------------------
  123.     /** @name Functions introduced in DOM Level 1 */
  124.     //@{
  125.     // -----------------------------------------------------------------------
  126.     //  Getter methods
  127.     // -----------------------------------------------------------------------
  128.     /**
  129.      * Returns the name of this attribute.
  130.      * @since DOM Level 1
  131.      */
  132.     virtual const XMLCh *       getName() const = 0;
  133.     /**
  134.      *
  135.      * Returns true if the attribute received its value explicitly in the
  136.      * XML document, or if a value was assigned programatically with
  137.      * the setValue function.  Returns false if the attribute value
  138.      * came from the default value declared in the document's DTD.
  139.      * @since DOM Level 1
  140.      */
  141.     virtual bool            getSpecified() const = 0;
  142.     /**
  143.      * Returns the value of the attribute.
  144.      *
  145.      * The value of the attribute is returned as a string.
  146.      * Character and general entity references are replaced with their values.
  147.      * @since DOM Level 1
  148.      */
  149.     virtual const XMLCh *       getValue() const = 0;
  150.     // -----------------------------------------------------------------------
  151.     //  Setter methods
  152.     // -----------------------------------------------------------------------
  153.     /**
  154.      * Sets the value of the attribute.  A text node with the unparsed contents
  155.      * of the string will be created.
  156.      *
  157.      * @param value The value of the DOM attribute to be set
  158.      * @since DOM Level 1
  159.      */
  160.     virtual void            setValue(const XMLCh *value) = 0;
  161.     //@}
  162.     /** @name Functions introduced in DOM Level 2. */
  163.     //@{
  164.     /**
  165.      * The <code>DOMElement</code> node this attribute is attached to or
  166.      * <code>null</code> if this attribute is not in use.
  167.      *
  168.      * @since DOM Level 2
  169.      */
  170.     virtual DOMElement     *getOwnerElement() const = 0;
  171.     //@}
  172.     /** @name Functions introduced in DOM Level 3. */
  173.     //@{
  174.     /**
  175.      * Returns whether this attribute is known to be of type ID or not. 
  176.      * When it is and its value is unique, the ownerElement of this attribute 
  177.      * can be retrieved using getElementById on Document.
  178.      *
  179.      * <p><b>"Experimental - subject to change"</b></p>
  180.      *
  181.      * @return <code>bool</code> stating if this <code>DOMAttr</code> is an ID
  182.      * @since DOM level 3
  183.      */
  184.     virtual bool            isId() const = 0;
  185.     /**
  186.      * Returns the type information associated with this attribute.
  187.      *
  188.      * <p><b>"Experimental - subject to change"</b></p>
  189.      *
  190.      * @return the <code>DOMTypeInfo</code> associated with this attribute
  191.      * @since DOM level 3
  192.      */
  193.     virtual const DOMTypeInfo * getTypeInfo() const = 0;
  194.     //@}
  195. };
  196. XERCES_CPP_NAMESPACE_END
  197. #endif