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-2003 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.12  2004/02/15 19:37:16  amassari
00060  * Removed cause for warnings in VC 7.1
00061  *
00062  * Revision 1.11  2003/11/21 22:34:46  neilg
00063  * More schema component model implementation, thanks to David Cargill.
00064  * In particular, this cleans up and completes the XSModel, XSNamespaceItem,
00065  * XSAttributeDeclaration and XSAttributeGroup implementations.
00066  *
00067  * Revision 1.10  2003/11/06 15:30:06  neilg
00068  * first part of PSVI/schema component model implementation, thanks to David Cargill.  This covers setting the PSVIHandler on parser objects, as well as implementing XSNotation, XSSimpleTypeDefinition, XSIDCDefinition, and most of XSWildcard, XSComplexTypeDefinition, XSElementDeclaration, XSAttributeDeclaration and XSAttributeUse.
00069  *
00070  * Revision 1.9  2003/10/10 16:23:29  peiyongz
00071  * Implementation of Serialization/Deserialization
00072  *
00073  * Revision 1.8  2003/05/22 02:10:51  knoaman
00074  * Default the memory manager.
00075  *
00076  * Revision 1.7  2003/05/16 21:36:55  knoaman
00077  * Memory manager implementation: Modify constructors to pass in the memory manager.
00078  *
00079  * Revision 1.6  2003/05/15 18:26:07  knoaman
00080  * Partial implementation of the configurable memory manager.
00081  *
00082  * Revision 1.5  2003/04/21 20:46:01  knoaman
00083  * Use XMLString::release to prepare for configurable memory manager.
00084  *
00085  * Revision 1.4  2003/03/07 18:08:10  tng
00086  * Return a reference instead of void for operator=
00087  *
00088  * Revision 1.3  2002/11/04 15:00:21  tng
00089  * C++ Namespace Support.
00090  *
00091  * Revision 1.2  2002/08/22 19:27:41  tng
00092  * [Bug 11448] DomCount has problems with XHTML1.1 DTD.
00093  *
00094  * Revision 1.1.1.1  2002/02/01 22:21:52  peiyongz
00095  * sane_include
00096  *
00097  * Revision 1.5  2000/03/02 19:54:25  roddey
00098  * This checkin includes many changes done while waiting for the
00099  * 1.1.0 code to be finished. I can't list them all here, but a list is
00100  * available elsewhere.
00101  *
00102  * Revision 1.4  2000/02/24 20:00:23  abagchi
00103  * Swat for removing Log from API docs
00104  *
00105  * Revision 1.3  2000/02/15 01:21:31  roddey
00106  * Some initial documentation improvements. More to come...
00107  *
00108  * Revision 1.2  2000/02/06 07:47:48  rahulj
00109  * Year 2K copyright swat.
00110  *
00111  * Revision 1.1.1.1  1999/11/09 01:08:35  twl
00112  * Initial checkin
00113  *
00114  * Revision 1.2  1999/11/08 20:44:39  rahul
00115  * Swat for adding in Product name and CVS comment log variable.
00116  *
00117  */
00118 
00119 #if !defined(XMLNOTATIONDECL_HPP)
00120 #define XMLNOTATIONDECL_HPP
00121 
00122 #include <xercesc/util/XMemory.hpp>
00123 #include <xercesc/util/PlatformUtils.hpp>
00124 #include <xercesc/util/XMLString.hpp>
00125 #include <xercesc/internal/XSerializable.hpp>
00126 
00127 XERCES_CPP_NAMESPACE_BEGIN
00128 
00138 class  XMLNotationDecl : public XSerializable, public XMemory
00139 {
00140 public:
00141     // -----------------------------------------------------------------------
00142     //  Constructors and Destructor
00143     // -----------------------------------------------------------------------
00144 
00147     XMLNotationDecl(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00148     XMLNotationDecl
00149     (
00150         const   XMLCh* const    notName
00151         , const XMLCh* const    pubId
00152         , const XMLCh* const    sysId
00153         , const XMLCh* const    baseURI = 0
00154         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00155     );
00157 
00160     ~XMLNotationDecl();
00162 
00163 
00164     // -----------------------------------------------------------------------
00165     //  Getter methods
00166     // -----------------------------------------------------------------------
00167     unsigned int getId() const;
00168     const XMLCh* getName() const;
00169     const XMLCh* getPublicId() const;
00170     const XMLCh* getSystemId() const;
00171     const XMLCh* getBaseURI() const;
00172     unsigned int getNameSpaceId() const;
00173     MemoryManager* getMemoryManager() const;
00174 
00175 
00176     // -----------------------------------------------------------------------
00177     //  Setter methods
00178     // -----------------------------------------------------------------------
00179     void setId(const unsigned int newId);
00180     void setName
00181     (
00182         const   XMLCh* const    notName
00183     );
00184     void setPublicId(const XMLCh* const newId);
00185     void setSystemId(const XMLCh* const newId);
00186     void setBaseURI(const XMLCh* const newId);
00187     void setNameSpaceId(const unsigned int newId);
00188 
00189     // -----------------------------------------------------------------------
00190     //  Support named collection element semantics
00191     // -----------------------------------------------------------------------
00192     const XMLCh* getKey() const;
00193 
00194     /***
00195      * Support for Serialization/De-serialization
00196      ***/
00197     DECL_XSERIALIZABLE(XMLNotationDecl)
00198 
00199 private :
00200     // -----------------------------------------------------------------------
00201     //  Unimplemented constructors and operators
00202     // -----------------------------------------------------------------------
00203     XMLNotationDecl(const XMLNotationDecl&);
00204     XMLNotationDecl& operator=(const XMLNotationDecl&);
00205 
00206 
00207     // -----------------------------------------------------------------------
00208     //  XMLNotationDecl: Private helper methods
00209     // -----------------------------------------------------------------------
00210     void cleanUp();
00211 
00212 
00213     // -----------------------------------------------------------------------
00214     //  Private data members
00215     //
00216     //  fId
00217     //      This is the unique id given to this notation decl.
00218     //
00219     //  fName
00220     //      The notation's name, which identifies the type of notation it
00221     //      applies to.
00222     //
00223     //  fPublicId
00224     //      The text of the notation's public id, if any.
00225     //
00226     //  fSystemId
00227     //      The text of the notation's system id, if any.
00228     //
00229     //  fBaseURI
00230     //      The text of the notation's base URI
00231     // -----------------------------------------------------------------------
00232     unsigned int    fId;
00233     XMLCh*          fName;
00234     XMLCh*          fPublicId;
00235     XMLCh*          fSystemId;
00236     XMLCh*          fBaseURI;
00237     unsigned int    fNameSpaceId;
00238     MemoryManager*  fMemoryManager;
00239 };
00240 
00241 
00242 // -----------------------------------------------------------------------
00243 //  Getter methods
00244 // -----------------------------------------------------------------------
00245 inline unsigned int XMLNotationDecl::getId() const
00246 {
00247     return fId;
00248 }
00249 
00250 inline const XMLCh* XMLNotationDecl::getName() const
00251 {
00252     return fName;
00253 }
00254 
00255 inline unsigned int XMLNotationDecl::getNameSpaceId() const
00256 {
00257     return fNameSpaceId;
00258 }
00259 
00260 inline const XMLCh* XMLNotationDecl::getPublicId() const
00261 {
00262     return fPublicId;
00263 }
00264 
00265 inline const XMLCh* XMLNotationDecl::getSystemId() const
00266 {
00267     return fSystemId;
00268 }
00269 
00270 inline const XMLCh* XMLNotationDecl::getBaseURI() const
00271 {
00272     return fBaseURI;
00273 }
00274 
00275 inline MemoryManager* XMLNotationDecl::getMemoryManager() const
00276 {
00277     return fMemoryManager;
00278 }
00279 
00280 // -----------------------------------------------------------------------
00281 //  Setter methods
00282 // -----------------------------------------------------------------------
00283 inline void XMLNotationDecl::setId(const unsigned int newId)
00284 {
00285     fId = newId;
00286 }
00287 
00288 inline void XMLNotationDecl::setNameSpaceId(const unsigned int newId)
00289 {
00290     fNameSpaceId = newId;
00291 }
00292 
00293 inline void XMLNotationDecl::setPublicId(const XMLCh* const newId)
00294 {
00295     if (fPublicId)
00296         fMemoryManager->deallocate(fPublicId);
00297 
00298     fPublicId = XMLString::replicate(newId, fMemoryManager);
00299 }
00300 
00301 inline void XMLNotationDecl::setSystemId(const XMLCh* const newId)
00302 {
00303     if (fSystemId)
00304         fMemoryManager->deallocate(fSystemId);
00305 
00306     fSystemId = XMLString::replicate(newId, fMemoryManager);
00307 }
00308 
00309 inline void XMLNotationDecl::setBaseURI(const XMLCh* const newId)
00310 {
00311     if (fBaseURI)
00312         fMemoryManager->deallocate(fBaseURI);
00313 
00314     fBaseURI = XMLString::replicate(newId, fMemoryManager);
00315 }
00316 
00317 
00318 // ---------------------------------------------------------------------------
00319 //  XMLNotationDecl: Support named pool element semantics
00320 // ---------------------------------------------------------------------------
00321 inline const XMLCh* XMLNotationDecl::getKey() const
00322 {
00323     return fName;
00324 }
00325 
00326 XERCES_CPP_NAMESPACE_END
00327 
00328 #endif


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