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

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
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  

XMLNotationDecl.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: XMLNotationDecl.hpp,v $
00059  * Revision 1.3  2002/11/04 15:00:21  tng
00060  * C++ Namespace Support.
00061  *
00062  * Revision 1.2  2002/08/22 19:27:41  tng
00063  * [Bug 11448] DomCount has problems with XHTML1.1 DTD.
00064  *
00065  * Revision 1.1.1.1  2002/02/01 22:21:52  peiyongz
00066  * sane_include
00067  *
00068  * Revision 1.5  2000/03/02 19:54:25  roddey
00069  * This checkin includes many changes done while waiting for the
00070  * 1.1.0 code to be finished. I can't list them all here, but a list is
00071  * available elsewhere.
00072  *
00073  * Revision 1.4  2000/02/24 20:00:23  abagchi
00074  * Swat for removing Log from API docs
00075  *
00076  * Revision 1.3  2000/02/15 01:21:31  roddey
00077  * Some initial documentation improvements. More to come...
00078  *
00079  * Revision 1.2  2000/02/06 07:47:48  rahulj
00080  * Year 2K copyright swat.
00081  *
00082  * Revision 1.1.1.1  1999/11/09 01:08:35  twl
00083  * Initial checkin
00084  *
00085  * Revision 1.2  1999/11/08 20:44:39  rahul
00086  * Swat for adding in Product name and CVS comment log variable.
00087  *
00088  */
00089 
00090 #if !defined(XMLNOTATIONDECL_HPP)
00091 #define XMLNOTATIONDECL_HPP
00092 
00093 #include <xercesc/util/XercesDefs.hpp>
00094 #include <xercesc/util/XMLString.hpp>
00095 
00096 XERCES_CPP_NAMESPACE_BEGIN
00097 
00107 class  XMLNotationDecl
00108 {
00109 public:
00110     // -----------------------------------------------------------------------
00111     //  Constructors and Destructor
00112     // -----------------------------------------------------------------------
00113 
00116     XMLNotationDecl();
00117     XMLNotationDecl
00118     (
00119         const   XMLCh* const    notName
00120         , const XMLCh* const    pubId
00121         , const XMLCh* const    sysId
00122         , const XMLCh* const    baseURI = 0
00123     );
00125 
00128     ~XMLNotationDecl();
00130 
00131 
00132     // -----------------------------------------------------------------------
00133     //  Getter methods
00134     // -----------------------------------------------------------------------
00135     unsigned int getId() const;
00136     const XMLCh* getName() const;
00137     const XMLCh* getPublicId() const;
00138     const XMLCh* getSystemId() const;
00139     const XMLCh* getBaseURI() const;
00140 
00141 
00142     // -----------------------------------------------------------------------
00143     //  Setter methods
00144     // -----------------------------------------------------------------------
00145     void setId(const unsigned int newId);
00146     void setName
00147     (
00148         const   XMLCh* const    notName
00149     );
00150     void setPublicId(const XMLCh* const newId);
00151     void setSystemId(const XMLCh* const newId);
00152     void setBaseURI(const XMLCh* const newId);
00153 
00154 
00155     // -----------------------------------------------------------------------
00156     //  Support named collection element semantics
00157     // -----------------------------------------------------------------------
00158     const XMLCh* getKey() const;
00159 
00160 
00161 private :
00162     // -----------------------------------------------------------------------
00163     //  Unimplemented constructors and operators
00164     // -----------------------------------------------------------------------
00165     XMLNotationDecl(const XMLNotationDecl&);
00166     void operator=(const XMLNotationDecl&);
00167 
00168 
00169     // -----------------------------------------------------------------------
00170     //  XMLNotationDecl: Private helper methods
00171     // -----------------------------------------------------------------------
00172     void cleanUp();
00173 
00174 
00175     // -----------------------------------------------------------------------
00176     //  Private data members
00177     //
00178     //  fId
00179     //      This is the unique id given to this notation decl.
00180     //
00181     //  fName
00182     //      The notation's name, which identifies the type of notation it
00183     //      applies to.
00184     //
00185     //  fPublicId
00186     //      The text of the notation's public id, if any.
00187     //
00188     //  fSystemId
00189     //      The text of the notation's system id, if any.
00190     //
00191     //  fBaseURI
00192     //      The text of the notation's base URI
00193     // -----------------------------------------------------------------------
00194     unsigned int    fId;
00195     XMLCh*          fName;
00196     XMLCh*          fPublicId;
00197     XMLCh*          fSystemId;
00198     XMLCh*          fBaseURI;
00199 };
00200 
00201 
00202 // -----------------------------------------------------------------------
00203 //  Getter methods
00204 // -----------------------------------------------------------------------
00205 inline unsigned int XMLNotationDecl::getId() const
00206 {
00207     return fId;
00208 }
00209 
00210 inline const XMLCh* XMLNotationDecl::getName() const
00211 {
00212     return fName;
00213 }
00214 
00215 inline const XMLCh* XMLNotationDecl::getPublicId() const
00216 {
00217     return fPublicId;
00218 }
00219 
00220 inline const XMLCh* XMLNotationDecl::getSystemId() const
00221 {
00222     return fSystemId;
00223 }
00224 
00225 inline const XMLCh* XMLNotationDecl::getBaseURI() const
00226 {
00227     return fBaseURI;
00228 }
00229 
00230 
00231 // -----------------------------------------------------------------------
00232 //  Setter methods
00233 // -----------------------------------------------------------------------
00234 inline void XMLNotationDecl::setId(const unsigned int newId)
00235 {
00236     fId = newId;
00237 }
00238 
00239 inline void XMLNotationDecl::setPublicId(const XMLCh* const newId)
00240 {
00241     delete [] fPublicId;
00242     fPublicId = XMLString::replicate(newId);
00243 }
00244 
00245 inline void XMLNotationDecl::setSystemId(const XMLCh* const newId)
00246 {
00247     delete [] fSystemId;
00248     fSystemId = XMLString::replicate(newId);
00249 }
00250 
00251 inline void XMLNotationDecl::setBaseURI(const XMLCh* const newId)
00252 {
00253     delete [] fBaseURI;
00254     fBaseURI = XMLString::replicate(newId);
00255 }
00256 
00257 
00258 // ---------------------------------------------------------------------------
00259 //  XMLNotationDecl: Support named pool element semantics
00260 // ---------------------------------------------------------------------------
00261 inline const XMLCh* XMLNotationDecl::getKey() const
00262 {
00263     return fName;
00264 }
00265 
00266 XERCES_CPP_NAMESPACE_END
00267 
00268 #endif


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