Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XalanDOMStringHashTable.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XALANDOMSTRINGHASHTABLE_HEADER_GUARD_1357924680)
00058 #define XALANDOMSTRINGHASHTABLE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 #include <xalanc/Include/XalanAutoPtr.hpp>
00072 
00073 
00074 
00075 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00076 
00077 
00078 
00079 XALAN_CPP_NAMESPACE_BEGIN
00080 
00081 
00082 
00083 class XALAN_PLATFORMSUPPORT_EXPORT XalanDOMStringHashTable
00084 {
00085 public:
00086 
00087 #if defined(XALAN_NO_STD_NAMESPACE)
00088     typedef vector<const XalanDOMString*>   BucketType;
00089     typedef BucketType::size_type           bucket_size_type;
00090     typedef vector<bucket_size_type>        BucketCountsType;
00091 #else
00092     typedef std::vector<const XalanDOMString*>  BucketType;
00093     typedef BucketType::size_type               bucket_size_type;
00094     typedef std::vector<bucket_size_type>       BucketCountsType;
00095 #endif
00096 
00097 
00098     enum { eDefaultBucketCount = 101, eDefaultBucketSize = 15 };
00099 
00100 
00107     explicit
00108     XalanDOMStringHashTable(
00109             size_t              theBucketCount = eDefaultBucketCount,
00110             bucket_size_type    theBucketSize = eDefaultBucketSize);
00111 
00112     ~XalanDOMStringHashTable() { }
00113 
00117     void
00118     clear();
00119 
00125     size_t
00126     size() const
00127     {
00128         return m_count;
00129     }
00130 
00136     size_t
00137     bucketCount() const
00138     {
00139         return m_bucketCount;
00140     }
00141 
00147     void
00148     getBucketCounts(BucketCountsType&   theVector) const;
00149 
00156     size_t
00157     collisions() const
00158     {
00159         return m_collisions;
00160     }
00161 
00169     const XalanDOMString*
00170     find(
00171             const XalanDOMString&   theString,
00172             size_t*                 theBucketIndex = 0) const;
00173 
00186     const XalanDOMString*
00187     find(
00188             const XalanDOMChar*         theString,
00189             XalanDOMString::size_type   theLength = XalanDOMString::npos,
00190             size_t*                     theBucketIndex = 0) const;
00191 
00204     void
00205     insert(const XalanDOMString&    theString);
00206 
00222     void
00223     insert(
00224             const XalanDOMString&   theString,
00225             size_t                  theBucketIndex);
00226 
00227 #if defined(XALAN_NEEDS_EXPLICIT_TEMPLATE_INSTANTIATION)
00228     struct
00229     equalsXalanDOMString
00230     {
00231         equalsXalanDOMString(
00232                 const XalanDOMChar*         theString,
00233                 XalanDOMString::size_type   theLength) :
00234             m_string(theString),
00235             m_length(theLength)
00236         {
00237         }
00238 
00239         bool
00240         operator()(const XalanDOMString*    theString) const;
00241 
00242     private:
00243 
00244         const XalanDOMChar* const           m_string;
00245 
00246         const XalanDOMString::size_type     m_length;
00247     };
00248 #endif
00249 
00250 private:
00251 
00252     // Not implemented, for now...
00253     XalanDOMStringHashTable(const XalanDOMStringHashTable&);
00254 
00255     XalanDOMStringHashTable&
00256     operator=(const XalanDOMStringHashTable&);
00257 
00258     bool
00259     operator==(const XalanDOMStringHashTable&) const;
00260 
00261 
00262     // Data members...
00263     const size_t                    m_bucketCount;
00264 
00265     const bucket_size_type          m_bucketSize;
00266 
00267     XalanArrayAutoPtr<BucketType>   m_buckets;
00268 
00269     size_t                          m_count;
00270 
00271     unsigned int                    m_collisions;       
00272 };
00273 
00274 
00275 
00276 XALAN_CPP_NAMESPACE_END
00277 
00278 
00279 
00280 #endif  // !defined(XALANDOMSTRINGPOOL_HEADER_GUARD_1357924680)

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.