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

词法分析

开发平台:

Visual C++

  1. #ifndef DOMEntity_HEADER_GUARD_
  2. #define DOMEntity_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: DOMEntity.hpp,v 1.7 2003/03/07 19:59:03 tng Exp $
  60.  */
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOMNode.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. /**
  65.  * This interface represents an entity, either parsed or unparsed, in an XML
  66.  * document. Note that this models the entity itself not the entity
  67.  * declaration. <code>DOMEntity</code> declaration modeling has been left for a
  68.  * later Level of the DOM specification.
  69.  * <p>The <code>nodeName</code> attribute that is inherited from
  70.  * <code>DOMNode</code> contains the name of the entity.
  71.  * <p>An XML processor may choose to completely expand entities before the
  72.  * structure model is passed to the DOM; in this case there will be no
  73.  * <code>DOMEntityReference</code> nodes in the document tree.
  74.  * <p>XML does not mandate that a non-validating XML processor read and
  75.  * process entity declarations made in the external subset or declared in
  76.  * external parameter entities. This means that parsed entities declared in
  77.  * the external subset need not be expanded by some classes of applications,
  78.  * and that the replacement value of the entity may not be available. When
  79.  * the replacement value is available, the corresponding <code>DOMEntity</code>
  80.  * node's child list represents the structure of that replacement text.
  81.  * Otherwise, the child list is empty.
  82.  * <p>The DOM Level 2 does not support editing <code>DOMEntity</code> nodes; if a
  83.  * user wants to make changes to the contents of an <code>DOMEntity</code>,
  84.  * every related <code>DOMEntityReference</code> node has to be replaced in the
  85.  * structure model by a clone of the <code>DOMEntity</code>'s contents, and
  86.  * then the desired changes must be made to each of those clones instead.
  87.  * <code>DOMEntity</code> nodes and all their descendants are readonly.
  88.  * <p>An <code>DOMEntity</code> node does not have any parent.If the entity
  89.  * contains an unbound namespace prefix, the <code>namespaceURI</code> of
  90.  * the corresponding node in the <code>DOMEntity</code> node subtree is
  91.  * <code>null</code>. The same is true for <code>DOMEntityReference</code>
  92.  * nodes that refer to this entity, when they are created using the
  93.  * <code>createEntityReference</code> method of the <code>DOMDocument</code>
  94.  * interface. The DOM Level 2 does not support any mechanism to resolve
  95.  * namespace prefixes.
  96.  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
  97.  *
  98.  * @since DOM Level 1
  99.  */
  100. class CDOM_EXPORT DOMEntity: public DOMNode {
  101. protected:
  102.     // -----------------------------------------------------------------------
  103.     //  Hidden constructors
  104.     // -----------------------------------------------------------------------
  105.     /** @name Hidden constructors */
  106.     //@{    
  107.     DOMEntity() {};
  108.     //@}
  109. private:
  110.     // -----------------------------------------------------------------------
  111.     // Unimplemented constructors and operators
  112.     // -----------------------------------------------------------------------
  113.     /** @name Unimplemented constructors and operators */
  114.     //@{
  115.     DOMEntity(const DOMEntity &);
  116.     DOMEntity & operator = (const DOMEntity &);
  117.     //@}
  118. public:
  119.     // -----------------------------------------------------------------------
  120.     //  All constructors are hidden, just the destructor is available
  121.     // -----------------------------------------------------------------------
  122.     /** @name Destructor */
  123.     //@{
  124.     /**
  125.      * Destructor
  126.      *
  127.      */
  128.     virtual ~DOMEntity() {};
  129.     //@}
  130.     // -----------------------------------------------------------------------
  131.     //  Virtual DOMEntity interface
  132.     // -----------------------------------------------------------------------
  133.     /** @name Functions introduced in DOM Level 1 */
  134.     //@{
  135.     // -----------------------------------------------------------------------
  136.     //  Getter methods
  137.     // -----------------------------------------------------------------------
  138.     /**
  139.      * The public identifier associated with the entity, if specified.
  140.      *
  141.      * If the public identifier was not specified, this is <code>null</code>.
  142.      *
  143.      * @since DOM Level 1
  144.      */
  145.     virtual const XMLCh *        getPublicId() const = 0;
  146.     /**
  147.      * The system identifier associated with the entity, if specified.
  148.      *
  149.      * If the system identifier was not specified, this is <code>null</code>.
  150.      *
  151.      * @since DOM Level 1
  152.      */
  153.     virtual const XMLCh *        getSystemId() const = 0;
  154.     /**
  155.      * For unparsed entities, the name of the notation for the entity.
  156.      *
  157.      * For parsed entities, this is <code>null</code>.
  158.      *
  159.      * @since DOM Level 1
  160.      */
  161.     virtual const XMLCh *        getNotationName() const = 0;
  162.     //@}
  163.     /** @name Functions introduced in DOM Level 3. */
  164.     //@{
  165.      /**
  166.      * An attribute specifying the actual encoding of this entity, when it is
  167.      * an external parsed entity. This is <code>null</code> otherwise.
  168.      *
  169.      * <p><b>"Experimental - subject to change"</b></p>
  170.      *
  171.      * @since DOM Level 3
  172.      */
  173.     virtual const XMLCh*           getActualEncoding() const = 0;
  174.     /**
  175.      * An attribute specifying the actual encoding of this entity, when it is
  176.      * an external parsed entity. This is <code>null</code> otherwise.
  177.      *
  178.      * <p><b>"Experimental - subject to change"</b></p>
  179.      *
  180.      * @since DOM Level 3
  181.      */
  182.     virtual void                   setActualEncoding(const XMLCh* actualEncoding) = 0;
  183.     /**
  184.      * An attribute specifying, as part of the text declaration, the encoding
  185.      * of this entity, when it is an external parsed entity. This is
  186.      * <code>null</code> otherwise.
  187.      *
  188.      * <p><b>"Experimental - subject to change"</b></p>
  189.      *
  190.      * @since DOM Level 3
  191.      */
  192.     virtual const XMLCh*           getEncoding() const = 0;
  193.     /**
  194.      * An attribute specifying, as part of the text declaration, the encoding
  195.      * of this entity, when it is an external parsed entity. This is
  196.      * <code>null</code> otherwise.
  197.      *
  198.      * <p><b>"Experimental - subject to change"</b></p>
  199.      *
  200.      * @since DOM Level 3
  201.      */
  202.     virtual void                   setEncoding(const XMLCh* encoding) = 0;
  203.     /**
  204.      * An attribute specifying, as part of the text declaration, the version
  205.      * number of this entity, when it is an external parsed entity. This is
  206.      * <code>null</code> otherwise.
  207.      *
  208.      * <p><b>"Experimental - subject to change"</b></p>
  209.      *
  210.      * @since DOM Level 3
  211.      */
  212.     virtual const XMLCh*           getVersion() const = 0;
  213.     /**
  214.      * An attribute specifying, as part of the text declaration, the version
  215.      * number of this entity, when it is an external parsed entity. This is
  216.      * <code>null</code> otherwise.
  217.      *
  218.      * <p><b>"Experimental - subject to change"</b></p>
  219.      *
  220.      * @since DOM Level 3
  221.      */
  222.     virtual void                   setVersion(const XMLCh* version) = 0;
  223.     //@}
  224. };
  225. XERCES_CPP_NAMESPACE_END
  226. #endif