www.alphaworks.ibm.comwww.ibm.com/developerwww.ibm.com

Home

Readme
Download

Build







Migration

Releases

Feedback

Y2K Compliance


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


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