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

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
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  

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.1.1.1  2002/02/01 22:22:11  peiyongz
00060  * sane_include
00061  *
00062  * Revision 1.8  2001/12/06 17:48:36  tng
00063  * 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.
00064  * 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.
00065  * 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.
00066  * By Henry Zongaro.
00067  *
00068  * Revision 1.7  2001/07/24 18:31:47  knoaman
00069  * Added support for <group> + extra constraint checking for complexType
00070  *
00071  * Revision 1.6  2001/05/11 13:26:28  tng
00072  * Copyright update.
00073  *
00074  * Revision 1.5  2001/04/19 18:17:10  tng
00075  * Schema: SchemaValidator update, and use QName in Content Model
00076  *
00077  * Revision 1.4  2001/03/21 21:56:12  tng
00078  * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
00079  *
00080  * Revision 1.3  2001/02/27 14:48:39  tng
00081  * Schema: Add CMAny and ContentLeafNameTypeVector, by Pei Yong Zhang
00082  *
00083  * Revision 1.2  2001/02/26 21:56:16  tng
00084  * Schema: QName can also be constructed with rawName.
00085  *
00086  * Revision 1.1  2001/02/26 19:44:25  tng
00087  * Schema: add utility class QName, by Pei Yong Zhang.
00088  *
00089  */
00090 
00091 #if !defined(QNAME_HPP)
00092 #define QNAME_HPP
00093 
00094 #include <xercesc/util/XMLString.hpp>
00095 #include <xercesc/util/XMLUniDefs.hpp>
00096 #include <xercesc/util/XMLUni.hpp>
00097 
00098 class  QName
00099 {
00100 public :
00101     // -----------------------------------------------------------------------
00102     //  Contructors and Destructor
00103     // -----------------------------------------------------------------------
00105     QName();
00106 
00108     QName
00109     (   const XMLCh* const        prefix
00110       , const XMLCh* const        localPart
00111        , const unsigned int        uriId
00112     );
00113 
00115     QName
00116     (   const XMLCh* const        rawName
00117        , const unsigned int        uriId
00118     );
00119 
00121     QName(const QName* const qname);
00122 
00123     ~QName();
00124 
00125     // -----------------------------------------------------------------------
00126     //  Getters
00127     // -----------------------------------------------------------------------
00128     const XMLCh* getPrefix() const;
00129     XMLCh* getPrefix();
00130 
00131     const XMLCh* getLocalPart() const;
00132     XMLCh* getLocalPart();
00133 
00134     const unsigned int getURI() const;
00135     unsigned int getURI();
00136 
00137     const XMLCh* getRawName() const;
00138     XMLCh* getRawName();
00139 
00140     // -----------------------------------------------------------------------
00141     //  Setters
00142     // -----------------------------------------------------------------------
00143     void setName
00144     (
00145         const XMLCh* const        prefix
00146       , const XMLCh* const        localPart
00147        , const unsigned int        uriId
00148     );
00149 
00150     void setName
00151     (
00152         const XMLCh* const        rawName
00153        , const unsigned int        uriId
00154     );
00155 
00156     void setPrefix(const XMLCh*) ;
00157     void setLocalPart(const XMLCh*) ;
00158     void setNPrefix(const XMLCh*, const unsigned int) ;
00159     void setNLocalPart(const XMLCh*, const unsigned int) ;
00160     void setURI(const unsigned int) ;
00161 
00162     void setValues(const QName& qname);
00163 
00164     // -----------------------------------------------------------------------
00165     //  comparison
00166     // -----------------------------------------------------------------------
00167     bool operator==(const QName&);
00168 
00169     // -----------------------------------------------------------------------
00170     //  Misc
00171     // -----------------------------------------------------------------------
00172     void cleanUp();
00173 
00174 private :
00175 
00176     // -----------------------------------------------------------------------
00177     //  Private instance variables
00178     //
00179     //  We copy the followings from XMLAttr.hpp, but stick to Java version's
00180     //  naming convention
00181     //
00182     //  fPrefix
00183     //  fPrefixBufSz
00184     //      The prefix that was applied to this attribute's name, and the
00185     //      current size of the buffer (minus one for the null.) Prefixes
00186     //      really don't matter technically but it might be required for
00187     //      pratical reasons, to recreate the original document for instance.
00188     //
00189     //  fLocalPart
00190     //  fLocalPartBufSz
00191     //      The base part of the name of the attribute, and the current size
00192     //      of the buffer (minus one, where the null is.)
00193     //
00194     //  fRawName
00195     //  fRawNameBufSz
00196     //      This is the QName form of the name, which is faulted in (from the
00197     //      prefix and name) upon request. The size field indicates the
00198     //      current size of the buffer (minus one for the null.) It will be
00199     //      zero until fauled in.
00200     //
00201     //  fURIId
00202     //      The id of the URI that this attribute belongs to.
00203     // -----------------------------------------------------------------------
00204     XMLCh*              fPrefix;
00205     unsigned int        fPrefixBufSz;
00206     XMLCh*              fLocalPart;
00207     unsigned int        fLocalPartBufSz;
00208     XMLCh*              fRawName;
00209     unsigned int        fRawNameBufSz;
00210     unsigned int        fURIId;
00211 
00212 };
00213 
00214 // ---------------------------------------------------------------------------
00215 //  QName: Getter methods
00216 // ---------------------------------------------------------------------------
00217 inline const XMLCh* QName::getPrefix() const
00218 {
00219     return fPrefix;
00220 }
00221 
00222 inline XMLCh* QName::getPrefix()
00223 {
00224     return fPrefix;
00225 }
00226 
00227 inline const XMLCh* QName::getLocalPart() const
00228 {
00229     return fLocalPart;
00230 }
00231 
00232 inline XMLCh* QName::getLocalPart()
00233 {
00234     return fLocalPart;
00235 }
00236 
00237 inline const unsigned int QName::getURI() const
00238 {
00239     return fURIId;
00240 }
00241 
00242 inline unsigned int QName::getURI()
00243 {
00244     return fURIId;
00245 }
00246 
00247 // ---------------------------------------------------------------------------
00248 //  QName: Setter methods
00249 // ---------------------------------------------------------------------------
00250 inline void QName::setURI(const unsigned int uriId)
00251 {
00252     fURIId = uriId;
00253 }
00254 #endif


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