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

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

ValueVectorOf.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  * 
00004  * Copyright (c) 1999-2000 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: ValueVectorOf.hpp,v $
00059  * Revision 1.4  2000/03/02 19:54:47  roddey
00060  * This checkin includes many changes done while waiting for the
00061  * 1.1.0 code to be finished. I can't list them all here, but a list is
00062  * available elsewhere.
00063  *
00064  * Revision 1.3  2000/02/24 20:05:26  abagchi
00065  * Swat for removing Log from API docs
00066  *
00067  * Revision 1.2  2000/02/06 07:48:05  rahulj
00068  * Year 2K copyright swat.
00069  *
00070  * Revision 1.1.1.1  1999/11/09 01:05:33  twl
00071  * Initial checkin
00072  *
00073  * Revision 1.2  1999/11/08 20:45:19  rahul
00074  * Swat for adding in Product name and CVS comment log variable.
00075  *
00076  */
00077 
00078 
00079 #if !defined(VALUEVECTOROF_HPP)
00080 #define VALUEVECTOROF_HPP
00081 
00082 #include <util/XercesDefs.hpp>
00083 #include <util/ArrayIndexOutOfBoundsException.hpp>
00084 #include <util/XMLEnumerator.hpp>
00085 
00086 
00087 template <class TElem> class ValueVectorOf
00088 {
00089 public :
00090     // -----------------------------------------------------------------------
00091     //  Constructors and Destructor
00092     // -----------------------------------------------------------------------
00093     ValueVectorOf(const unsigned int maxElems);
00094     ValueVectorOf(const ValueVectorOf<TElem>& toCopy);
00095     ~ValueVectorOf();
00096 
00097 
00098     // -----------------------------------------------------------------------
00099     //  Operators
00100     // -----------------------------------------------------------------------
00101     ValueVectorOf<TElem>& operator=(const ValueVectorOf<TElem>& toAssign);
00102 
00103     
00104     // -----------------------------------------------------------------------
00105     //  Element management
00106     // -----------------------------------------------------------------------
00107     void addElement(const TElem& toAdd);
00108     void setElementAt(const TElem& toSet, const unsigned int setAt);
00109     void insertElementAt(const TElem& toInsert, const unsigned int insertAt);
00110     void removeElementAt(const unsigned int removeAt);
00111     void removeAllElements();
00112 
00113 
00114     // -----------------------------------------------------------------------
00115     //  Getter methods
00116     // -----------------------------------------------------------------------
00117     const TElem& elementAt(const unsigned int getAt) const;
00118     TElem& elementAt(const unsigned int getAt);
00119     unsigned int curCapacity() const;
00120     unsigned int size() const;
00121 
00122 
00123     // -----------------------------------------------------------------------
00124     //  Miscellaneous
00125     // -----------------------------------------------------------------------
00126     void ensureExtraCapacity(const unsigned int length);
00127     const TElem* rawData() const;
00128 
00129 
00130 private:
00131     // -----------------------------------------------------------------------
00132     //  Data members
00133     //
00134     //  fCurCount
00135     //      The count of values current added to the vector, which may be
00136     //      less than the internal capacity.
00137     //
00138     //  fMaxCount
00139     //      The current capacity of the vector.
00140     //
00141     //  fElemList
00142     //      The list of elements, which is dynamically allocated to the needed
00143     //      size.
00144     // -----------------------------------------------------------------------
00145     unsigned int    fCurCount;
00146     unsigned int    fMaxCount;
00147     TElem*          fElemList;
00148 };
00149 
00150 
00151 //
00152 //  An enumerator for a value vector. It derives from the basic enumerator
00153 //  class, so that value vectors can be generically enumerated.
00154 //
00155 template <class TElem> class ValueVectorEnumerator : public XMLEnumerator<TElem>
00156 {
00157 public :
00158     // -----------------------------------------------------------------------
00159     //  Constructors and Destructor
00160     // -----------------------------------------------------------------------
00161     ValueVectorEnumerator
00162     (
00163                 ValueVectorOf<TElem>* const toEnum
00164         , const bool                        adopt = false
00165     );
00166     ~ValueVectorEnumerator();
00167 
00168 
00169     // -----------------------------------------------------------------------
00170     //  Enum interface
00171     // -----------------------------------------------------------------------
00172     bool hasMoreElements() const;
00173     TElem& nextElement();
00174     void Reset();
00175 
00176 
00177 private :    
00178     // -----------------------------------------------------------------------
00179     //  Data Members
00180     //
00181     //  fAdopted
00182     //      Indicates whether we have adopted the passed vector. If so then
00183     //      we delete the vector when we are destroyed.
00184     //
00185     //  fCurIndex
00186     //      This is the current index into the vector.
00187     //
00188     //  fToEnum
00189     //      The value vector being enumerated.
00190     // -----------------------------------------------------------------------
00191     bool                    fAdopted;
00192     unsigned int            fCurIndex;
00193     ValueVectorOf<TElem>*   fToEnum;
00194 };
00195 
00196 
00197 #if !defined(XERCES_TMPLSINC)
00198 #include <util/ValueVectorOf.c>
00199 #endif
00200 
00201 #endif


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