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

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-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) 1999, 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: StringPool.hpp,v $
  58.  * Revision 1.5  2001/10/22 15:43:35  tng
  59.  * [Bug 3361] "String pool id was not legal" error in Attributes::getURI().
  60.  *
  61.  * Revision 1.4  2000/07/07 22:16:52  jpolast
  62.  * remove old put(value) function.  use put(key,value) instead.
  63.  *
  64.  * Revision 1.3  2000/02/24 20:05:25  abagchi
  65.  * Swat for removing Log from API docs
  66.  *
  67.  * Revision 1.2  2000/02/06 07:48:04  rahulj
  68.  * Year 2K copyright swat.
  69.  *
  70.  * Revision 1.1.1.1  1999/11/09 01:05:11  twl
  71.  * Initial checkin
  72.  *
  73.  * Revision 1.2  1999/11/08 20:45:15  rahul
  74.  * Swat for adding in Product name and CVS comment log variable.
  75.  *
  76.  */
  77. #if !defined(STRINGPOOL_HPP)
  78. #define STRINGPOOL_HPP
  79. #include <util/RefHashTableOf.hpp>
  80. //
  81. //  This class implements a string pool, in which strings can be added and
  82. //  given a unique id by which they can be refered. It has to provide fast
  83. //  access both mapping from a string to its id and mapping from an id to
  84. //  its string. This requires that it provide two separate data structures.
  85. //  The map one is a hash table for quick storage and look up by name. The
  86. //  other is an array ordered by unique id which maps to the element in the
  87. //  hash table.
  88. //
  89. //  This works because strings cannot be removed from the pool once added,
  90. //  other than flushing it completely, and because ids are assigned
  91. //  sequentially from 1.
  92. //
  93. class XMLUTIL_EXPORT XMLStringPool
  94. {
  95. public :
  96.     // -----------------------------------------------------------------------
  97.     //  Constructors and Destructor
  98.     // -----------------------------------------------------------------------
  99.     XMLStringPool
  100.     (
  101.         const   unsigned int    modulus = 109
  102.     );
  103.     ~XMLStringPool();
  104.     // -----------------------------------------------------------------------
  105.     //  Pool management methods
  106.     // -----------------------------------------------------------------------
  107.     unsigned int addOrFind(const XMLCh* const newString);
  108.     bool exists(const XMLCh* const newString) const;
  109.     bool exists(const unsigned int id) const;
  110.     void flushAll();
  111.     unsigned int getId(const XMLCh* const toFind) const;
  112.     const XMLCh* getValueForId(const unsigned int id) const;
  113. private :
  114.     // -----------------------------------------------------------------------
  115.     //  Private data types
  116.     // -----------------------------------------------------------------------
  117.     class PoolElem
  118.     {
  119.         public :
  120.             PoolElem(const XMLCh* const string, const unsigned int id);
  121.             ~PoolElem();
  122.             inline const XMLCh* getKey() const { return fString; }
  123.             void reset(const XMLCh* const string, const unsigned int id);
  124.             unsigned int    fId;
  125.             XMLCh*          fString;
  126.     };
  127.     // -----------------------------------------------------------------------
  128.     //  Unimplemented constructors and operators
  129.     // -----------------------------------------------------------------------
  130.     XMLStringPool(const XMLStringPool&);
  131.     void operator=(const XMLStringPool&);
  132.     // -----------------------------------------------------------------------
  133.     //  Private helper methods
  134.     // -----------------------------------------------------------------------
  135.     unsigned int addNewEntry(const XMLCh* const newString);
  136.     // -----------------------------------------------------------------------
  137.     //  Private data members
  138.     //
  139.     //  fIdMap
  140.     //      This is an array of pointers to the pool elements. It is ordered
  141.     //      by unique id, so using an id to index it gives instant access to
  142.     //      the string of that id. This is grown as required.
  143.     //
  144.     //  fHashTable
  145.     //      This is the hash table used to store and quickly access the
  146.     //      strings.
  147.     //
  148.     //  fMapCapacity
  149.     //      The current capacity of the id map. When the current id hits this
  150.     //      value the map must must be expanded.
  151.     //
  152.     //  fCurId
  153.     //      This is the counter used to assign unique ids. It is just bumped
  154.     //      up one for each new string added.
  155.     // -----------------------------------------------------------------------
  156.     PoolElem**                  fIdMap;
  157.     RefHashTableOf<PoolElem>*   fHashTable;
  158.     unsigned int                fMapCapacity;
  159.     unsigned int                fCurId;
  160. };
  161. #endif