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


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