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  

XSNamedMap.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 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: XSNamedMap.hpp,v $
00059  * Revision 1.3  2004/01/29 11:46:30  cargilld
00060  * Code cleanup changes to get rid of various compiler diagnostic messages.
00061  *
00062  * Revision 1.2  2003/11/06 15:30:04  neilg
00063  * first part of PSVI/schema component model implementation, thanks to David Cargill.  This covers setting the PSVIHandler on parser objects, as well as implementing XSNotation, XSSimpleTypeDefinition, XSIDCDefinition, and most of XSWildcard, XSComplexTypeDefinition, XSElementDeclaration, XSAttributeDeclaration and XSAttributeUse.
00064  *
00065  * Revision 1.1  2003/09/16 14:33:36  neilg
00066  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00067  *
00068  */
00069 
00070 
00071 #if !defined(XSNAMEDMAP_HPP)
00072 #define XSNAMEDMAP_HPP
00073 
00074 
00075 #include <xercesc/util/XMemory.hpp>
00076 #include <xercesc/util/RefHash2KeysTableOf.hpp>
00077 
00078 XERCES_CPP_NAMESPACE_BEGIN
00079 
00080 class XMLStringPool;
00081 
00082 /*
00083  * This template provides convenient mappings between name,namespace
00084  * pairs and individual components, as well as means to iterate through all the 
00085  * named components on some object.
00086  */
00087 
00088 template <class TVal> class XSNamedMap: public XMemory
00089 {
00090 public:
00091     // -----------------------------------------------------------------------
00092     //  Constructors and Destructor
00093     // -----------------------------------------------------------------------
00096 
00097     XSNamedMap(const unsigned int maxElems,
00098         const unsigned int modulus,
00099         XMLStringPool* uriStringPool,
00100         const bool adoptElems,
00101         MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00102     );
00104 
00107     ~XSNamedMap();
00108 
00110 
00111     // -----------------------------------------------------------------------
00112     //  XSNamedMap methods
00113     // -----------------------------------------------------------------------
00116 
00122     unsigned int getLength();
00123 
00133     TVal *item(unsigned int index);
00134 
00146     TVal *itemByName(const XMLCh *compNamespace, 
00147                               const XMLCh *localName);
00148 
00150 
00151     //----------------------------------
00155     void addElement(TVal* const toAdd, const XMLCh* key1, const XMLCh* key2);
00157     
00158 
00159 private :
00160     // -----------------------------------------------------------------------
00161     //  Unimplemented constructors and operators
00162     // -----------------------------------------------------------------------
00163     XSNamedMap(const XSNamedMap<TVal>&);
00164     XSNamedMap<TVal>& operator=(const XSNamedMap<TVal>&);
00165 
00166     // -----------------------------------------------------------------------
00167     //  Data members
00168     //
00169     // fMemoryManager
00170     //  manager used to allocate memory needed by this object
00171     MemoryManager *const        fMemoryManager;
00172     XMLStringPool*              fURIStringPool;
00173     RefVectorOf<TVal>*          fVector;
00174     RefHash2KeysTableOf<TVal>*  fHash;
00175 };
00176 
00177 
00178 
00179 XERCES_CPP_NAMESPACE_END
00180 
00181 #if !defined(XERCES_TMPLSINC)
00182 #include <xercesc/framework/psvi/XSNamedMap.c>
00183 #endif
00184 
00185 #endif


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