PSVIAttributeList.hpp Source 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: PSVIAttributeList.hpp,v $
00059  * Revision 1.7  2004/02/15 19:37:16  amassari
00060  * Removed cause for warnings in VC 7.1
00061  *
00062  * Revision 1.6  2003/12/20 06:19:38  neilg
00063  * store name/namespace of corresponding attribute in PSVIAttributeList; not all PSVIAttributes have XSAttributeDeclarations
00064  *
00065  * Revision 1.5  2003/12/15 17:23:48  cargilld
00066  * psvi updates; cleanup revisits and bug fixes
00067  *
00068  * Revision 1.4  2003/12/02 16:21:41  neilg
00069  * fix for ArrayIndexOutOfBoundsException in PSVIAttributeList; thanks to Pete Lloyd
00070  *
00071  * Revision 1.3  2003/11/26 16:20:37  neilg
00072  * more complete implementation of PSVIAttributeList; remove some problematic const-ness
00073  *
00074  * Revision 1.2  2003/11/06 15:30:04  neilg
00075  * 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.
00076  *
00077  * Revision 1.1  2003/09/16 14:33:36  neilg
00078  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00079  *
00080  */
00081 
00082 #if !defined(PSVIATTRIBUTEDERIVATION_LIST_HPP)
00083 #define PSVIATTRIBUTEDERIVATION_LIST_HPP
00084 
00085 #include <xercesc/util/PlatformUtils.hpp>
00086 #include <xercesc/framework/psvi/PSVIAttribute.hpp>
00087 #include <xercesc/util/ValueVectorOf.hpp>
00088 
00089 XERCES_CPP_NAMESPACE_BEGIN
00090 
00100 class  PSVIAttributeList : public XMemory
00101 {
00102 public:
00103 
00104     //  Constructors and Destructor
00105     // -----------------------------------------------------------------------
00108 
00114     PSVIAttributeList( MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00115 
00117 
00120     ~PSVIAttributeList();
00122 
00123     //---------------------
00127 
00128     /*
00129      * Get the number of attributes whose PSVI contributions
00130      * are contained in this list.
00131      */
00132     unsigned int getLength() const;
00133 
00134     /*
00135      * Get the PSVI contribution of attribute at position i
00136      * in this list.  Indeces start from 0.
00137      * @param index index from which the attribute PSVI contribution
00138      * is to come.  
00139      * @return PSVIAttribute containing the attributes PSVI contributions;
00140      * null is returned if the index is out of range.
00141      */
00142     PSVIAttribute *getAttributePSVIAtIndex(const unsigned int index);
00143 
00144     /*
00145      * Get local part of attribute name at position index in the list.
00146      * Indeces start from 0.
00147      * @param index index from which the attribute name 
00148      * is to come.  
00149      * @return local part of the attribute's name; null is returned if the index
00150      * is out of range.
00151      */
00152     const XMLCh *getAttributeNameAtIndex(const unsigned int index);
00153 
00154     /*
00155      * Get namespace of attribute at position index in the list.
00156      * Indeces start from 0.
00157      * @param index index from which the attribute namespace 
00158      * is to come.  
00159      * @return namespace of the attribute; 
00160      * null is returned if the index is out of range.
00161      */
00162     const XMLCh *getAttributeNamespaceAtIndex(const unsigned int index);
00163 
00164     /*
00165      * Get the PSVI contribution of attribute with given 
00166      * local name and namespace.
00167      * @param attrName  local part of the attribute's name
00168      * @param attrNamespace  namespace of the attribute
00169      * @return null if the attribute PSVI does not exist
00170      */
00171     PSVIAttribute *getAttributePSVIByName(const XMLCh *attrName
00172                     , const XMLCh * attrNamespace);
00173 
00175 
00176     //----------------------------------
00180 
00189     PSVIAttribute *getPSVIAttributeToFill(
00190             const XMLCh * attrName
00191             , const XMLCh * attrNS);
00192 
00196     void reset();
00197 
00199 
00200 private:
00201 
00202     // -----------------------------------------------------------------------
00203     //  Unimplemented constructors and operators
00204     // -----------------------------------------------------------------------
00205     PSVIAttributeList(const PSVIAttributeList&);
00206     PSVIAttributeList & operator=(const PSVIAttributeList &);
00207 
00208 
00209     // -----------------------------------------------------------------------
00210     //  data members
00211     // -----------------------------------------------------------------------
00212     // fMemoryManager
00213     //  handler to provide dynamically-need memory
00214     // fAttrList
00215     //  list of PSVIAttributes contained by this object
00216     // fAttrNameList
00217     //  list of the names of the initialized PSVIAttribute objects contained
00218     //  in this listing
00219     // fAttrNSList
00220     //  list of the namespaces of the initialized PSVIAttribute objects contained
00221     //  in this listing
00222     // fAttrPos
00223     //  current number of initialized PSVIAttributes in fAttrList
00224     MemoryManager*                  fMemoryManager;    
00225     RefVectorOf<PSVIAttribute>*     fAttrList;
00226     RefArrayVectorOf<XMLCh>*        fAttrNameList;
00227     RefArrayVectorOf<XMLCh>*        fAttrNSList;
00228     unsigned int                    fAttrPos;
00229 };
00230 inline PSVIAttributeList::~PSVIAttributeList() 
00231 {
00232     delete fAttrList;
00233     delete fAttrNameList;
00234     delete fAttrNSList;
00235 }
00236 
00237 inline PSVIAttribute *PSVIAttributeList::getPSVIAttributeToFill(
00238             const XMLCh *attrName
00239             , const XMLCh * attrNS)
00240 {
00241     PSVIAttribute *retAttr = 0;
00242     if(fAttrPos == fAttrList->size())
00243     {
00244         retAttr = new (fMemoryManager)PSVIAttribute(fMemoryManager);
00245         fAttrList->addElement(retAttr);
00246         fAttrNameList->addElement((XMLCh *)attrName);
00247         fAttrNSList->addElement((XMLCh *)attrNS);
00248     }
00249     else
00250     {
00251         retAttr = fAttrList->elementAt(fAttrPos);
00252         fAttrNameList->setElementAt((XMLCh *)attrName, fAttrPos);
00253         fAttrNSList->setElementAt((XMLCh *)attrNS, fAttrPos);
00254     }
00255     fAttrPos++;
00256     return retAttr;
00257 }
00258 
00259 inline void PSVIAttributeList::reset()
00260 {
00261     fAttrPos = 0;
00262 }
00263 
00264 XERCES_CPP_NAMESPACE_END
00265 
00266 #endif