| API Docs for SAX and DOM |
| Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members # QName.hpp Go to the documentation of this file.
    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 2001 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) 2001, 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: QName.hpp,v $
    00059  * Revision 1.5  2002/11/04 15:22:04  tng
    00060  * C++ Namespace Support.
    00061  *
    00062  * Revision 1.4  2002/10/30 21:52:00  tng
    00063  * [Bug 13641] compiler-generated copy-constructor for QName doesn't do the right thing.
    00064  *
    00065  * Revision 1.3  2002/09/05 16:06:41  tng
    00066  * [Bug 12232] Make operator to be constant.
    00067  *
    00068  * Revision 1.2  2002/08/20 16:54:25  tng
    00069  * [Bug 6251] Info during compilation.
    00070  *
    00071  * Revision 1.1.1.1  2002/02/01 22:22:11  peiyongz
    00072  * sane_include
    00073  *
    00074  * Revision 1.8  2001/12/06 17:48:36  tng
    00075  * Performance Enhancement.  Added setNPrefix and setNLocalPart methods that allow code to take advantage of the fact that it knows the length of the prefix and local name, when possible.  That can avoid a copy of the prefix into a null-terminated temporary variable before copying into the fPrefix.
    00076  * Also changed the getRawName method so that it would simply return the local part when there is no prefix, instead of allocating another buffer to copy the local part into the fRawName.
    00077  * When there is a prefix, changed the getRawName to copy the prefix and local part into the fRawName using XMLString::moveChars instead of using XMLString::copyString and XMLString::catString.  The catString method has to loop past the prefix portion of the fRawName, which seems like a waste.
    00078  * By Henry Zongaro.
    00079  *
    00080  * Revision 1.7  2001/07/24 18:31:47  knoaman
    00081  * Added support for <group> + extra constraint checking for complexType
    00082  *
    00083  * Revision 1.6  2001/05/11 13:26:28  tng
    00084  * Copyright update.
    00085  *
    00086  * Revision 1.5  2001/04/19 18:17:10  tng
    00087  * Schema: SchemaValidator update, and use QName in Content Model
    00088  *
    00089  * Revision 1.4  2001/03/21 21:56:12  tng
    00090  * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
    00091  *
    00092  * Revision 1.3  2001/02/27 14:48:39  tng
    00093  * Schema: Add CMAny and ContentLeafNameTypeVector, by Pei Yong Zhang
    00094  *
    00095  * Revision 1.2  2001/02/26 21:56:16  tng
    00096  * Schema: QName can also be constructed with rawName.
    00097  *
    00098  * Revision 1.1  2001/02/26 19:44:25  tng
    00099  * Schema: add utility class QName, by Pei Yong Zhang.
    00100  *
    00101  */
    00102
    00103 #if !defined(QNAME_HPP)
    00104 #define QNAME_HPP
    00105
    00106 #include <xercesc/util/XMLString.hpp>
    00107 #include <xercesc/util/XMLUniDefs.hpp>
    00108 #include <xercesc/util/XMLUni.hpp>
    00109
    00110 XERCES_CPP_NAMESPACE_BEGIN
    00111
    00112 class  QName
    00113 {
    00114 public :
    00115     // -----------------------------------------------------------------------
    00116     //  Contructors and Destructor
    00117     // -----------------------------------------------------------------------
    00119     QName();
    00120
    00122     QName
    00123     (   const XMLCh* const        prefix
    00124       , const XMLCh* const        localPart
    00125        , const unsigned int        uriId
    00126     );
    00127
    00129     QName
    00130     (   const XMLCh* const        rawName
    00131        , const unsigned int        uriId
    00132     );
    00133
    00135     QName(const QName& qname);
    00136
    00137     ~QName();
    00138
    00139     // -----------------------------------------------------------------------
    00140     //  Getters
    00141     // -----------------------------------------------------------------------
    00142     const XMLCh* getPrefix() const;
    00143     XMLCh* getPrefix();
    00144
    00145     const XMLCh* getLocalPart() const;
    00146     XMLCh* getLocalPart();
    00147
    00148     unsigned int getURI() const;
    00149
    00150     const XMLCh* getRawName() const;
    00151     XMLCh* getRawName();
    00152
    00153     // -----------------------------------------------------------------------
    00154     //  Setters
    00155     // -----------------------------------------------------------------------
    00156     void setName
    00157     (
    00158         const XMLCh* const        prefix
    00159       , const XMLCh* const        localPart
    00160        , const unsigned int        uriId
    00161     );
    00162
    00163     void setName
    00164     (
    00165         const XMLCh* const        rawName
    00166        , const unsigned int        uriId
    00167     );
    00168
    00169     void setPrefix(const XMLCh*) ;
    00170     void setLocalPart(const XMLCh*) ;
    00171     void setNPrefix(const XMLCh*, const unsigned int) ;
    00172     void setNLocalPart(const XMLCh*, const unsigned int) ;
    00173     void setURI(const unsigned int) ;
    00174
    00175     void setValues(const QName& qname);
    00176
    00177     // -----------------------------------------------------------------------
    00178     //  comparison
    00179     // -----------------------------------------------------------------------
    00180     bool operator==(const QName&) const;
    00181
    00182     // -----------------------------------------------------------------------
    00183     //  Misc
    00184     // -----------------------------------------------------------------------
    00185     void cleanUp();
    00186
    00187 private :
    00188
    00189     // -----------------------------------------------------------------------
    00190     //  Private instance variables
    00191     //
    00192     //  We copy the followings from XMLAttr.hpp, but stick to Java version's
    00193     //  naming convention
    00194     //
    00195     //  fPrefix
    00196     //  fPrefixBufSz
    00197     //      The prefix that was applied to this attribute's name, and the
    00198     //      current size of the buffer (minus one for the null.) Prefixes
    00199     //      really don't matter technically but it might be required for
    00200     //      pratical reasons, to recreate the original document for instance.
    00201     //
    00202     //  fLocalPart
    00203     //  fLocalPartBufSz
    00204     //      The base part of the name of the attribute, and the current size
    00205     //      of the buffer (minus one, where the null is.)
    00206     //
    00207     //  fRawName
    00208     //  fRawNameBufSz
    00209     //      This is the QName form of the name, which is faulted in (from the
    00210     //      prefix and name) upon request. The size field indicates the
    00211     //      current size of the buffer (minus one for the null.) It will be
    00212     //      zero until fauled in.
    00213     //
    00214     //  fURIId
    00215     //      The id of the URI that this attribute belongs to.
    00216     // -----------------------------------------------------------------------
    00217     XMLCh*              fPrefix;
    00218     unsigned int        fPrefixBufSz;
    00219     XMLCh*              fLocalPart;
    00220     unsigned int        fLocalPartBufSz;
    00221     XMLCh*              fRawName;
    00222     unsigned int        fRawNameBufSz;
    00223     unsigned int        fURIId;
    00224
    00225 };
    00226
    00227 // ---------------------------------------------------------------------------
    00228 //  QName: Getter methods
    00229 // ---------------------------------------------------------------------------
    00230 inline const XMLCh* QName::getPrefix() const
    00231 {
    00232     return fPrefix;
    00233 }
    00234
    00235 inline XMLCh* QName::getPrefix()
    00236 {
    00237     return fPrefix;
    00238 }
    00239
    00240 inline const XMLCh* QName::getLocalPart() const
    00241 {
    00242     return fLocalPart;
    00243 }
    00244
    00245 inline XMLCh* QName::getLocalPart()
    00246 {
    00247     return fLocalPart;
    00248 }
    00249
    00250 inline unsigned int QName::getURI() const
    00251 {
    00252     return fURIId;
    00253 }
    00254
    00255 // ---------------------------------------------------------------------------
    00256 //  QName: Setter methods
    00257 // ---------------------------------------------------------------------------
    00258 inline void QName::setURI(const unsigned int uriId)
    00259 {
    00260     fURIId = uriId;
    00261 }
    00262
    00263 XERCES_CPP_NAMESPACE_END
    00264
    00265 #endif

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