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

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