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

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.  * $Log: IDOM_CharacterData.hpp,v $
  58.  * Revision 1.3  2001/06/04 20:44:14  tng
  59.  * IDOM: Comment should say XMLCh instead of DOMString
  60.  *
  61.  * Revision 1.2  2001/05/11 13:25:49  tng
  62.  * Copyright update.
  63.  *
  64.  * Revision 1.1.1.1  2001/04/03 00:14:27  andyh
  65.  * IDOM
  66.  *
  67.  */
  68. #ifndef IDOM_CharacterData_HEADER_GUARD_
  69. #define IDOM_CharacterData_HEADER_GUARD_
  70. #include <util/XercesDefs.hpp>
  71. #include <idom/IDOM_Node.hpp>
  72. /**
  73.  * The <code>IDOM_CharacterData</code> interface extends Node with a set  of
  74.  * methods for accessing character data in the DOM.
  75.  *
  76.  * For clarity this set is defined here rather than on each class that uses
  77.  * these methods. No DOM objects correspond directly to
  78.  * <code>CharacterData</code>, though <code>Text</code> and others do inherit
  79.  * the interface from it. All <code>offset</code>s in this interface start
  80.  * from 0, and index in terms of Unicode 16 bit storage units.
  81.  */
  82. class CDOM_EXPORT IDOM_CharacterData: public IDOM_Node {
  83. protected:
  84.     IDOM_CharacterData() {};
  85.     IDOM_CharacterData(const IDOM_CharacterData &other) {};
  86.     IDOM_CharacterData & operator = (const IDOM_CharacterData &other) {return *this;};
  87. public:
  88.     /** @name Destructor. */
  89.     //@{
  90.  /**
  91.   * Destructor for IDOM_CharacterData.  The object being destroyed
  92.       * is the reference to the Character Data node, not the character
  93.       * data itself.
  94.   */
  95.     virtual ~IDOM_CharacterData() {};
  96.     //@}
  97.     /** @name Getter functions. */
  98.     //@{
  99.   /**
  100.    * Returns the character data of the node that implements this interface.
  101.    *
  102.    * The DOM implementation may not put arbitrary limits on the amount of data that
  103.    * may be stored in a  <code>CharacterData</code> node. However,
  104.    * implementation limits may  mean that the entirety of a node's data may
  105.    * not fit into a single <code>XMLCh* String</code>. In such cases, the user
  106.    * may call <code>substringData</code> to retrieve the data in
  107.    * appropriately sized pieces.
  108.    * @exception DOMException
  109.    *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  110.    */
  111.   virtual const XMLCh *     getData() const = 0;
  112.   /**
  113.    * Returns the number of characters that are available through <code>data</code> and
  114.    * the <code>substringData</code> method below.
  115.    *
  116.    * This may have the value
  117.    * zero, i.e., <code>CharacterData</code> nodes may be empty.
  118.    */
  119.   virtual unsigned int       getLength() const = 0;
  120.   /**
  121.    * Extracts a range of data from the node.
  122.    *
  123.    * @param offset Start offset of substring to extract.
  124.    * @param count The number of characters to extract.
  125.    * @return The specified substring. If the sum of <code>offset</code> and
  126.    *   <code>count</code> exceeds the <code>length</code>, then all
  127.    *   characters to the end of the data are returned.
  128.    * @exception DOMException
  129.    *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  130.    *   than the number of characters in <code>data</code>, or if the
  131.    *   specified <code>count</code> is negative.
  132.    */
  133.   virtual const XMLCh *     substringData(unsigned int offset,
  134.                                    unsigned int count) const = 0;
  135.     //@}
  136.     /** @name Functions that set or change data. */
  137.     //@{
  138.   /**
  139.    * Append the string to the end of the character data of the node.
  140.    *
  141.    * Upon success, <code>data</code> provides access to the concatenation of
  142.    * <code>data</code> and the <code>XMLCh* String</code> specified.
  143.    * @param arg The <code>XMLCh* String</code> to append.
  144.    * @exception DOMException
  145.    *   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  146.    */
  147.   virtual void               appendData(const XMLCh *arg) = 0;
  148.   /**
  149.    * Insert a string at the specified character offset.
  150.    *
  151.    * @param offset The character offset at which to insert.
  152.    * @param arg The <code>XMLCh* String</code> to insert.
  153.    * @exception DOMException
  154.    *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  155.    *   than the number of characters in <code>data</code>.
  156.    *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  157.    */
  158.   virtual void               insertData(unsigned int offset, const  XMLCh *arg) = 0;
  159.   /**
  160.    * Remove a range of characters from the node.
  161.    *
  162.    * Upon success,
  163.    * <code>data</code> and <code>length</code> reflect the change.
  164.    * @param offset The offset from which to remove characters.
  165.    * @param count The number of characters to delete. If the sum of
  166.    *   <code>offset</code> and <code>count</code> exceeds <code>length</code>
  167.    *   then all characters from <code>offset</code> to the end of the data
  168.    *   are deleted.
  169.    * @exception DOMException
  170.    *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  171.    *   than the number of characters in <code>data</code>, or if the
  172.    *   specified <code>count</code> is negative.
  173.    *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  174.    */
  175.   virtual void               deleteData(unsigned int offset,
  176.                                 unsigned int count) = 0;
  177.   /**
  178.    * Replace the characters starting at the specified character offset with
  179.    * the specified string.
  180.    *
  181.    * @param offset The offset from which to start replacing.
  182.    * @param count The number of characters to replace. If the sum of
  183.    *   <code>offset</code> and <code>count</code> exceeds <code>length</code>
  184.    *   , then all characters to the end of the data are replaced (i.e., the
  185.    *   effect is the same as a <code>remove</code> method call with the same
  186.    *   range, followed by an <code>append</code> method invocation).
  187.    * @param arg The <code>XMLCh* String</code> with which the range must be
  188.    *   replaced.
  189.    * @exception DOMException
  190.    *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  191.    *   than the number of characters in <code>data</code>, or if the
  192.    *   specified <code>count</code> is negative.
  193.    *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  194.    */
  195.   virtual void               replaceData(unsigned int offset,
  196.                                  unsigned int count,
  197.                                  const XMLCh *arg) = 0;
  198.   /**
  199.    * Sets the character data of the node that implements this interface.
  200.    *
  201.    * @param data The <code>XMLCh* String</code> to set.
  202.    */
  203.   virtual void               setData(const XMLCh *data) = 0;
  204.   //@}
  205. };
  206. #endif