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

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2001 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) 2001, 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: IDEntityReferenceImpl.cpp,v 1.3 2001/12/07 01:37:24 tng Exp $
  58.  */
  59. /**
  60. * EntityReference models the XML &entityname; syntax, when used for
  61. * entities defined by the DOM. Entities hardcoded into XML, such as
  62. * character entities, should instead have been translated into text
  63. * by the code which generated the DOM tree.
  64. * <P>
  65. * An XML processor has the alternative of fully expanding Entities
  66. * into the normal document tree. If it does so, no EntityReference nodes
  67. * will appear.
  68. * <P>
  69. * Similarly, non-validating XML processors are not required to read
  70. * or process entity declarations made in the external subset or
  71. * declared in external parameter entities. Hence, some applications
  72. * may not make the replacement value available for Parsed Entities
  73. * of these types.
  74. * <P>
  75. * EntityReference behaves as a read-only node, and the children of
  76. * the EntityReference (which reflect those of the Entity, and should
  77. * also be read-only) give its replacement value, if any. They are
  78. * supposed to automagically stay in synch if the DocumentType is
  79. * updated with new values for the Entity.
  80. * <P>
  81. * The defined behavior makes efficient storage difficult for the DOM
  82. * implementor. We can't just look aside to the Entity's definition
  83. * in the DocumentType since those nodes have the wrong parent (unless
  84. * we can come up with a clever "imaginary parent" mechanism). We
  85. * must at least appear to clone those children... which raises the
  86. * issue of keeping the reference synchronized with its parent.
  87. * This leads me back to the "cached image of centrally defined data"
  88. * solution, much as I dislike it.
  89. * <P>
  90. * For now I have decided, since REC-DOM-Level-1-19980818 doesn't
  91. * cover this in much detail, that synchronization doesn't have to be
  92. * considered while the user is deep in the tree. That is, if you're
  93. * looking within one of the EntityReferennce's children and the Entity
  94. * changes, you won't be informed; instead, you will continue to access
  95. * the same object -- which may or may not still be part of the tree.
  96. * This is the same behavior that obtains elsewhere in the DOM if the
  97. * subtree you're looking at is deleted from its parent, so it's
  98. * acceptable here. (If it really bothers folks, we could set things
  99. * up so deleted subtrees are walked and marked invalid, but that's
  100. * not part of the DOM's defined behavior.)
  101. * <P>
  102. * As a result, only the EntityReference itself has to be aware of
  103. * changes in the Entity. And it can take advantage of the same
  104. * structure-change-monitoring code I implemented to support
  105. * DeepNodeList.
  106. *
  107. * @author Rania Y. Khalaf
  108. * @author Joseph Kesselman
  109. * @since  PR-DOM-Level-1-19980818.
  110. */
  111. #include "IDDocumentImpl.hpp"
  112. #include "IDDocumentTypeImpl.hpp"
  113. #include "IDEntityImpl.hpp"
  114. #include "IDEntityReferenceImpl.hpp"
  115. #include "IDOM_DOMException.hpp"
  116. #include "IDOM_Node.hpp"
  117. #include "IDNamedNodeMapImpl.hpp"
  118. IDEntityReferenceImpl::IDEntityReferenceImpl(IDOM_Document *ownerDoc,
  119.                                          const XMLCh *entityName)
  120.     : fNode(ownerDoc), fParent(ownerDoc)
  121. {
  122.     fName = ((IDDocumentImpl *)getOwnerDocument())->getPooledString(entityName);
  123.     // EntityReference behaves as a read-only node, since its contents
  124.     // reflect the Entity it refers to -- but see setNodeName().
  125.     fNode.isReadOnly(true);
  126. }
  127. IDEntityReferenceImpl::IDEntityReferenceImpl(const IDEntityReferenceImpl &other,
  128.                                          bool deep)
  129.     : fNode(other.fNode), fParent(other.fParent), fChild(other.fChild)
  130. {
  131.     fName = other.fName;
  132.     if (deep)
  133.         fParent.cloneChildren(&other);
  134.     fNode.isReadOnly(true);
  135. }
  136. IDEntityReferenceImpl::~IDEntityReferenceImpl()
  137. {
  138. }
  139. IDOM_Node *IDEntityReferenceImpl::cloneNode(bool deep) const
  140. {
  141.     return new (getOwnerDocument()) IDEntityReferenceImpl(*this, deep);
  142. }
  143. const XMLCh * IDEntityReferenceImpl::getNodeName() const
  144. {
  145.     return fName;
  146. };
  147. short IDEntityReferenceImpl::getNodeType() const {
  148.     return IDOM_Node::ENTITY_REFERENCE_NODE;
  149. };
  150. /**
  151. * EntityReferences never have a nodeValue.
  152. * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR)
  153. */
  154. void IDEntityReferenceImpl::setNodeValue(const XMLCh *x)
  155. {
  156.     fNode.setNodeValue(x);
  157. }
  158. /**
  159. * EntityRef is already, and must be, a read-only node. Attempts to change
  160. * that will throw a NO_MODIFICATION_ALLOWED_ERR DOMException.
  161. * <P>
  162. * If you want to alter its contents, edit the Entity definition.
  163. *
  164. * @param readOnly boolean
  165. */
  166. void IDEntityReferenceImpl::setReadOnly(bool readOnl,bool deep)
  167. {
  168.     if(readOnl==false)
  169.         throw IDOM_DOMException(IDOM_DOMException::NO_MODIFICATION_ALLOWED_ERR, 0);
  170.     fNode.setReadOnly(readOnl,deep);
  171. }
  172. //
  173. //   Delegate functions from Node to the appropriate implementation.
  174. //
  175.            IDOM_Node          *IDEntityReferenceImpl::appendChild(IDOM_Node *newChild)        {return fParent.appendChild (newChild); };
  176.            IDOM_NamedNodeMap  *IDEntityReferenceImpl::getAttributes() const          {return fNode.getAttributes (); };
  177.            IDOM_NodeList      *IDEntityReferenceImpl::getChildNodes() const          {return fParent.getChildNodes (); };
  178.            IDOM_Node          *IDEntityReferenceImpl::getFirstChild() const          {return fParent.getFirstChild (); };
  179.            IDOM_Node          *IDEntityReferenceImpl::getLastChild() const              {return fParent.getLastChild (); };
  180.      const XMLCh              *IDEntityReferenceImpl::getLocalName() const                    {return fNode.getLocalName (); };
  181.      const XMLCh              *IDEntityReferenceImpl::getNamespaceURI() const                 {return fNode.getNamespaceURI (); };
  182.            IDOM_Node          *IDEntityReferenceImpl::getNextSibling() const                  {return fChild.getNextSibling (); };
  183.      const XMLCh              *IDEntityReferenceImpl::getNodeValue() const                    {return fNode.getNodeValue (); };
  184.            IDOM_Document      *IDEntityReferenceImpl::getOwnerDocument() const                {return fNode.getOwnerDocument (); };
  185.      const XMLCh              *IDEntityReferenceImpl::getPrefix() const                       {return fNode.getPrefix (); };
  186.            IDOM_Node          *IDEntityReferenceImpl::getParentNode() const                   {return fChild.getParentNode (this); };
  187.            IDOM_Node          *IDEntityReferenceImpl::getPreviousSibling() const              {return fChild.getPreviousSibling (this); };
  188.            bool                IDEntityReferenceImpl::hasChildNodes() const                   {return fParent.hasChildNodes (); };
  189.            IDOM_Node          *IDEntityReferenceImpl::insertBefore(IDOM_Node *newChild, IDOM_Node *refChild)
  190.                                                                             {return fParent.insertBefore (newChild, refChild); };
  191.            void                IDEntityReferenceImpl::normalize()                             {fNode.normalize (); };
  192.            IDOM_Node          *IDEntityReferenceImpl::removeChild(IDOM_Node *oldChild)        {return fParent.removeChild (oldChild); };
  193.            IDOM_Node          *IDEntityReferenceImpl::replaceChild(IDOM_Node *newChild, IDOM_Node *oldChild)
  194.                                                                             {return fParent.replaceChild (newChild, oldChild); };
  195.            bool                IDEntityReferenceImpl::supports(const XMLCh *feature, const XMLCh *version) const
  196.                                                                             {return fNode.supports (feature, version); };
  197.            void                IDEntityReferenceImpl::setPrefix(const XMLCh  *prefix)         {fNode.setPrefix(prefix); };