http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

SynchronizedStringPool.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: SynchronizedStringPool.hpp,v $
00059  * Revision 1.1  2003/10/09 13:51:16  neilg
00060  * implementation of a StringPool implementation that permits thread-safe updates.  This can now be used by a grammar pool that is locked so that scanners have somehwere to store information about newly-encountered URIs
00061  *
00062  */
00063 
00064 #if !defined(SYNCHRONIZEDSTRINGPOOL_HPP)
00065 #define SYNCHRONIZEDSTRINGPOOL_HPP
00066 
00067 #include <xercesc/framework/MemoryManager.hpp>
00068 #include <xercesc/util/StringPool.hpp>
00069 #include <xercesc/util/Mutexes.hpp>
00070 
00071 XERCES_CPP_NAMESPACE_BEGIN
00072 
00073 //
00074 //  This class provides a synchronized string pool implementation.
00075 //  This will necessarily be slower than the regular StringPool, so it
00076 //  should only be used when updates need to be made in a thread-safe
00077 //  way.  Updates will be made on datastructures local to this object;
00078 //  all queries that don't involve mutation will first be directed at
00079 //  the StringPool implementation with which this object is
00080 //  constructed.
00081 class  XMLSynchronizedStringPool : public XMLStringPool
00082 {
00083 public :
00084     // -----------------------------------------------------------------------
00085     //  Constructors and Destructor
00086     // -----------------------------------------------------------------------
00087     XMLSynchronizedStringPool
00088     (
00089         const XMLStringPool *  constPool
00090         , const unsigned int   modulus = 109
00091         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00092     );
00093     virtual ~XMLSynchronizedStringPool();
00094 
00095 
00096     // -----------------------------------------------------------------------
00097     //  Pool management methods
00098     // -----------------------------------------------------------------------
00099     virtual unsigned int addOrFind(const XMLCh* const newString);
00100     virtual bool exists(const XMLCh* const newString) const;
00101     virtual bool exists(const unsigned int id) const;
00102     virtual void flushAll();
00103     virtual unsigned int getId(const XMLCh* const toFind) const;
00104     virtual const XMLCh* getValueForId(const unsigned int id) const;
00105     virtual unsigned int getStringCount() const;
00106 
00107 
00108 private :
00109     // -----------------------------------------------------------------------
00110     //  Unimplemented constructors and operators
00111     // -----------------------------------------------------------------------
00112     XMLSynchronizedStringPool(const XMLSynchronizedStringPool&);
00113     XMLSynchronizedStringPool& operator=(const XMLSynchronizedStringPool&);
00114 
00115 
00116     // -----------------------------------------------------------------------
00117     // private data members
00118     //  fConstPool
00119     //      the pool whose immutability we're protecting
00120     // fMutex
00121     //      mutex to permit synchronous updates of our StringPool
00122     const XMLStringPool* fConstPool;
00123     XMLMutex             fMutex;
00124 };
00125 
00126 XERCES_CPP_NAMESPACE_END
00127 
00128 #endif


Copyright © 2004 The Apache Software Foundation. All Rights Reserved.