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.2  2003/11/06 15:30:04  neilg
00060  * 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.
00061  *
00062  * Revision 1.1  2003/09/16 14:33:36  neilg
00063  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00064  *
00065  */
00066 
00067 
00068 #if !defined(XSNAMEDMAP_HPP)
00069 #define XSNAMEDMAP_HPP
00070 
00071 
00072 #include <xercesc/util/XMemory.hpp>
00073 #include <xercesc/util/RefHash2KeysTableOf.hpp>
00074 
00075 XERCES_CPP_NAMESPACE_BEGIN
00076 
00077 class XMLStringPool;
00078 
00079 /*
00080  * This template provides convenient mappings between name,namespace
00081  * pairs and individual components, as well as means to iterate through all the 
00082  * named components on some object.
00083  */
00084 
00085 template <class TVal> class XSNamedMap: public XMemory
00086 {
00087 public:
00088     // -----------------------------------------------------------------------
00089     //  Constructors and Destructor
00090     // -----------------------------------------------------------------------
00093 
00094     XSNamedMap(const unsigned int maxElems,
00095         const unsigned int modulus,
00096         XMLStringPool* uriStringPool,
00097         const bool adoptElems,
00098         MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00099     );
00101 
00104     ~XSNamedMap();
00105 
00107 
00108     // -----------------------------------------------------------------------
00109     //  XSNamedMap methods
00110     // -----------------------------------------------------------------------
00113 
00119     unsigned int getLength();
00120 
00130     TVal *item(unsigned int index);
00131 
00143     TVal *itemByName(const XMLCh *compNamespace, 
00144                               const XMLCh *localName);
00145 
00147 
00148     //----------------------------------
00152     void addElement(TVal* const toAdd, const XMLCh* key1, const XMLCh* key2);
00154     
00155 
00156 private :
00157     // -----------------------------------------------------------------------
00158     //  Private methods
00159     // -----------------------------------------------------------------------
00160 
00161     // -----------------------------------------------------------------------
00162     //  Data members
00163     //
00164     // fMemoryManager
00165     //  manager used to allocate memory needed by this object
00166     MemoryManager *const        fMemoryManager;
00167     XMLStringPool*              fURIStringPool;
00168     RefVectorOf<TVal>*          fVector;
00169     RefHash2KeysTableOf<TVal>*  fHash;
00170 };
00171 
00172 
00173 
00174 XERCES_CPP_NAMESPACE_END
00175 
00176 #if !defined(XERCES_TMPLSINC)
00177 #include <xercesc/framework/psvi/XSNamedMap.c>
00178 #endif
00179 
00180 #endif


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