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

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: IDDeepNodeListPool.hpp,v $
  58.  * Revision 1.1  2001/06/04 14:55:32  tng
  59.  * IDOM: Add IRange and IDeepNodeList Support.
  60.  *
  61.  */
  62. #if !defined(IDDEEPNODELISTPOOL_HPP)
  63. #define IDDEEPNODELISTPOOL_HPP
  64. #include <util/XercesDefs.hpp>
  65. #include <util/KeyValuePair.hpp>
  66. #include <util/HashBase.hpp>
  67. #include <util/IllegalArgumentException.hpp>
  68. #include <util/NoSuchElementException.hpp>
  69. #include <util/RuntimeException.hpp>
  70. #include <util/XMLExceptMsgs.hpp>
  71. #include <util/XMLEnumerator.hpp>
  72. #include <util/XMLString.hpp>
  73. #include <util/HashBase.hpp>
  74. #include <util/HashXMLCh.hpp>
  75. #include <util/HashPtr.hpp>
  76. // This hash table is modified from IDDeepNodeListPoolTableOf with first key as object ptr (IDOM_Node),
  77. // second and third keys are both XMLCh* string
  78. //
  79. //  Forward declare the enumerator so he can be our friend. Can you say
  80. //  friend? Sure...
  81. //
  82. template <class TVal> class IDDeepNodeListPoolEnumerator;
  83. template <class TVal> struct IDDeepNodeListPoolTableBucketElem;
  84. //
  85. //  This should really be a nested class, but some of the compilers we
  86. //  have to support cannot deal with that!
  87. //
  88. template <class TVal> struct IDDeepNodeListPoolTableBucketElem
  89. {
  90.     IDDeepNodeListPoolTableBucketElem(
  91.               void* key1
  92.               , XMLCh* key2
  93.               , XMLCh* key3
  94.               , TVal* const value
  95.               , IDDeepNodeListPoolTableBucketElem<TVal>* next) :
  96. fData(value)
  97.     , fNext(next)
  98.     , fKey1(key1)
  99.     , fKey2(0)
  100.     , fKey3(0)
  101.     {
  102.         if (key2)
  103.             fKey2 = XMLString::replicate(key2);
  104.         if (key3)
  105.             fKey3 = XMLString::replicate(key3);
  106.     }
  107.     TVal*  fData;
  108.     IDDeepNodeListPoolTableBucketElem<TVal>*   fNext;
  109.     void*  fKey1;
  110.     XMLCh* fKey2;
  111.     XMLCh* fKey3;
  112. };
  113. template <class TVal> class IDDeepNodeListPool
  114. {
  115. public:
  116.     // -----------------------------------------------------------------------
  117.     //  Constructors and Destructor
  118.     // -----------------------------------------------------------------------
  119.     // backwards compatability - default hasher is HashXMLCh
  120.     IDDeepNodeListPool
  121.     (
  122.         const unsigned int modulus
  123.       , const unsigned int    initSize = 128
  124.     );
  125.     // backwards compatability - default hasher is HashXMLCh
  126.     IDDeepNodeListPool
  127.     (
  128.         const unsigned int modulus
  129.       , const bool adoptElems
  130.       , const unsigned int initSize = 128
  131.     );
  132.     // if a hash function is passed in, it will be deleted when the hashtable is deleted.
  133.     // use a new instance of the hasher class for each hashtable, otherwise one hashtable
  134.     // may delete the hasher of a different hashtable if both use the same hasher.
  135.     IDDeepNodeListPool
  136.     (
  137.          const unsigned int modulus
  138.        , const bool adoptElems, HashBase* hash
  139.        , const unsigned int initSize = 128
  140.     );
  141.     ~IDDeepNodeListPool();
  142.     // -----------------------------------------------------------------------
  143.     //  Element management
  144.     // -----------------------------------------------------------------------
  145.     bool isEmpty() const;
  146.     bool containsKey(const void* const key1, const XMLCh* const key2, const XMLCh* const key3) const;
  147.     void removeAll();
  148.     // -----------------------------------------------------------------------
  149.     //  Getters
  150.     // -----------------------------------------------------------------------
  151.     TVal* getByKey(const void* const key1, const XMLCh* const key2, const XMLCh* const key3);
  152.     const TVal* getByKey(const void* const key1, const XMLCh* const key2, const XMLCh* const key3) const;
  153.     TVal* getById(const unsigned elemId);
  154.     const TVal* getById(const unsigned elemId) const;
  155.     // -----------------------------------------------------------------------
  156.     //  Putters
  157.     // -----------------------------------------------------------------------
  158. unsigned int put(void* key1, XMLCh* key2, XMLCh* key3, TVal* const valueToAdopt);
  159. private :
  160.     // -----------------------------------------------------------------------
  161.     //  Declare our friends
  162.     // -----------------------------------------------------------------------
  163.     friend class IDDeepNodeListPoolEnumerator<TVal>;
  164. private:
  165.     // -----------------------------------------------------------------------
  166.     //  Private methods
  167.     // -----------------------------------------------------------------------
  168.     IDDeepNodeListPoolTableBucketElem<TVal>* findBucketElem(const void* const key1, const XMLCh* const key2, const XMLCh* const key3, unsigned int& hashVal);
  169.     const IDDeepNodeListPoolTableBucketElem<TVal>* findBucketElem(const void* const key1, const XMLCh* const key2, const XMLCh* const key3, unsigned int& hashVal) const;
  170.     void initialize(const unsigned int modulus);
  171.     // -----------------------------------------------------------------------
  172.     //  Data members
  173.     //
  174.     //  fAdoptedElems
  175.     //      Indicates whether the values added are adopted or just referenced.
  176.     //      If adopted, then they are deleted when they are removed from the
  177.     //      hash table.
  178.     //
  179.     //  fBucketList
  180.     //      This is the array that contains the heads of all of the list
  181.     //      buckets, one for each possible hash value.
  182.     //
  183.     //  fHashModulus
  184.     //      The modulus used for this hash table, to hash the keys. This is
  185.     //      also the number of elements in the bucket list.
  186.     //
  187.     //  fHash
  188.     //      The hasher for the key1 data type.
  189.     //
  190.     //  fIdPtrs
  191.     //  fIdPtrsCount
  192.     //      This is the array of pointers to the bucket elements in order of
  193.     //      their assigned ids. So taking id N and referencing this array
  194.     //      gives you the element with that id. The count field indicates
  195.     //      the current size of this list. When fIdCounter+1 reaches this
  196.     //      value the list must be expanded.
  197.     //
  198.     //  fIdCounter
  199.     //      This is used to give out unique ids to added elements. It starts
  200.     //      at zero (which means empty), and is bumped up for each newly added
  201.     //      element. So the first element is 1, the next is 2, etc... This
  202.     //      means that this value is set to the top index of the fIdPtrs array.
  203.     // -----------------------------------------------------------------------
  204.     bool                                fAdoptedElems;
  205.     IDDeepNodeListPoolTableBucketElem<TVal>** fBucketList;
  206.     unsigned int                        fHashModulus;
  207.     HashBase*                       fHash;
  208.     TVal**                          fIdPtrs;
  209.     unsigned int                    fIdPtrsCount;
  210.     unsigned int                    fIdCounter;
  211. };
  212. //
  213. //  An enumerator for a value array. It derives from the basic enumerator
  214. //  class, so that value vectors can be generically enumerated.
  215. //
  216. template <class TVal> class IDDeepNodeListPoolEnumerator : public XMLEnumerator<TVal>
  217. {
  218. public :
  219.     // -----------------------------------------------------------------------
  220.     //  Constructors and Destructor
  221.     // -----------------------------------------------------------------------
  222.     IDDeepNodeListPoolEnumerator(IDDeepNodeListPool<TVal>* const toEnum, const bool adopt = false);
  223.     ~IDDeepNodeListPoolEnumerator();
  224.     // -----------------------------------------------------------------------
  225.     //  Enum interface
  226.     // -----------------------------------------------------------------------
  227.     bool hasMoreElements() const;
  228.     TVal& nextElement();
  229.     void Reset();
  230. private :
  231.     // -----------------------------------------------------------------------
  232.     //  Data Members
  233.     //  fAdoptedElems
  234.     //      Indicates whether the values added are adopted or just referenced.
  235.     //      If adopted, then they are deleted when they are removed from the
  236.     //      hash table
  237.     //
  238.     //  fCurIndex
  239.     //      This is the current index into the pool's id mapping array. This
  240.     //      is now we enumerate it.
  241.     //
  242.     //  fToEnum
  243.     //      The name id pool that is being enumerated.
  244.     // -----------------------------------------------------------------------
  245.     bool                       fAdoptedElems;
  246.     unsigned int               fCurIndex;
  247.     IDDeepNodeListPool<TVal>*  fToEnum;
  248. };
  249. #if !defined(XERCES_TMPLSINC)
  250. #include <idom/IDDeepNodeListPool.c>
  251. #endif
  252. #endif