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

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

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


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