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.4  2003/12/02 16:21:41  neilg
00060  * fix for ArrayIndexOutOfBoundsException in PSVIAttributeList; thanks to Pete Lloyd
00061  *
00062  * Revision 1.3  2003/11/26 16:20:37  neilg
00063  * more complete implementation of PSVIAttributeList; remove some problematic const-ness
00064  *
00065  * Revision 1.2  2003/11/06 15:30:04  neilg
00066  * 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.
00067  *
00068  * Revision 1.1  2003/09/16 14:33:36  neilg
00069  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00070  *
00071  */
00072 
00073 #if !defined(PSVIATTRIBUTEDERIVATION_LIST_HPP)
00074 #define PSVIATTRIBUTEDERIVATION_LIST_HPP
00075 
00076 #include <xercesc/util/PlatformUtils.hpp>
00077 #include <xercesc/framework/psvi/PSVIAttribute.hpp>
00078 #include <xercesc/util/ValueVectorOf.hpp>
00079 
00080 XERCES_CPP_NAMESPACE_BEGIN
00081 
00091 class  PSVIAttributeList : public XMemory
00092 {
00093 public:
00094 
00095     //  Constructors and Destructor
00096     // -----------------------------------------------------------------------
00099 
00105     PSVIAttributeList( MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00106 
00108 
00111     ~PSVIAttributeList();
00113 
00114     //---------------------
00118 
00119     /*
00120      * Get the number of attributes whose PSVI contributions
00121      * are contained in this list.
00122      */
00123     const unsigned int getLength() const;
00124 
00125     /*
00126      * Get the PSVI contribution of attribute at position i
00127      * in this list.  Indeces start from 0.
00128      * @param index index from which the attribute PSVI contribution
00129      * is to come.  
00130      * @return PSVIAttribute containing the attributes PSVI contributions;
00131      * null is returned if the index is out of range.
00132      */
00133     PSVIAttribute *getAttributePSVIAtIndex(const unsigned int index);
00134 
00135     /*
00136      * Get local part of attribute name at position index in the list.
00137      * Indeces start from 0.
00138      * @param index index from which the attribute name 
00139      * is to come.  
00140      * @return local part of the attribute's name; null is returned if the index
00141      * is out of range.
00142      */
00143     const XMLCh *getAttributeNameAtIndex(const unsigned int index);
00144 
00145     /*
00146      * Get namespace of attribute at position index in the list.
00147      * Indeces start from 0.
00148      * @param index index from which the attribute namespace 
00149      * is to come.  
00150      * @return namespace of the attribute; 
00151      * null is returned if the index is out of range.
00152      */
00153     const XMLCh *getAttributeNamespaceAtIndex(const unsigned int index);
00154 
00155     /*
00156      * Get the PSVI contribution of attribute with given 
00157      * local name and namespace.
00158      * @param attrName  local part of the attribute's name
00159      * @param attrNamespace  namespace of the attribute
00160      * @return null if the attribute PSVI does not exist
00161      */
00162     PSVIAttribute *getAttributePSVIByName(const XMLCh *attrName
00163                     , const XMLCh * attrNamespace);
00164 
00166 
00167     //----------------------------------
00171 
00177     PSVIAttribute *getPSVIAttributeToFill();
00178 
00182     void reset();
00183 
00185 
00186 private:
00187 
00188     // -----------------------------------------------------------------------
00189     //  Unimplemented constructors and operators
00190     // -----------------------------------------------------------------------
00191     PSVIAttributeList(const PSVIAttributeList&);
00192     PSVIAttributeList & operator=(const PSVIAttributeList &);
00193 
00194 
00195     // -----------------------------------------------------------------------
00196     //  data members
00197     // -----------------------------------------------------------------------
00198     // fMemoryManager
00199     //  handler to provide dynamically-need memory
00200     // fAttrList
00201     //  list of PSVIAttributes contained by this object
00202     // fAttrPos
00203     //  current number of valid PSVIAttributes in fAttrList
00204     MemoryManager*                  fMemoryManager;
00205     ValueVectorOf<PSVIAttribute*>*  fAttrList;
00206     unsigned int                    fAttrPos;
00207 };
00208 inline PSVIAttributeList::~PSVIAttributeList() 
00209 {
00210     delete fAttrList;
00211 }
00212 
00213 inline PSVIAttribute *PSVIAttributeList::getPSVIAttributeToFill()
00214 {
00215     PSVIAttribute *retAttr = 0;
00216     if(fAttrPos == fAttrList->size())
00217     {
00218         retAttr = new (fMemoryManager)PSVIAttribute(fMemoryManager);
00219         fAttrList->addElement(retAttr);
00220     }
00221     else
00222     {
00223         retAttr = fAttrList->elementAt(fAttrPos);
00224     }
00225     fAttrPos++;
00226     return retAttr;
00227 }
00228 
00229 inline void PSVIAttributeList::reset()
00230 {
00231     fAttrPos = 0;
00232 }
00233 
00234 XERCES_CPP_NAMESPACE_END
00235 
00236 #endif