Main Page   Class Hierarchy   Compound List   File List   Compound Members  

XMLNotationDecl.hpp

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  2002/05/11 20:03:35  bhavani
00060  * CR#CR062582# adding xercesc 1.7 file
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 XMLPARSER_EXPORT 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     );
00119 
00122     ~XMLNotationDecl();
00124 
00125 
00126     // -----------------------------------------------------------------------
00127     //  Getter methods
00128     // -----------------------------------------------------------------------
00129     unsigned int getId() const;
00130     const XMLCh* getName() const;
00131     const XMLCh* getPublicId() const;
00132     const XMLCh* getSystemId() const;
00133 
00134 
00135     // -----------------------------------------------------------------------
00136     //  Setter methods
00137     // -----------------------------------------------------------------------
00138     void setId(const unsigned int newId);
00139     void setName
00140     (
00141         const   XMLCh* const    notName
00142     );
00143     void setPublicId(const XMLCh* const newId);
00144     void setSystemId(const XMLCh* const newId);
00145 
00146 
00147     // -----------------------------------------------------------------------
00148     //  Support named collection element semantics
00149     // -----------------------------------------------------------------------
00150     const XMLCh* getKey() const;
00151 
00152 
00153 private :
00154     // -----------------------------------------------------------------------
00155     //  Unimplemented constructors and operators
00156     // -----------------------------------------------------------------------
00157     XMLNotationDecl(const XMLNotationDecl&);
00158     void operator=(const XMLNotationDecl&);
00159 
00160 
00161     // -----------------------------------------------------------------------
00162     //  XMLNotationDecl: Private helper methods
00163     // -----------------------------------------------------------------------
00164     void cleanUp();
00165 
00166 
00167     // -----------------------------------------------------------------------
00168     //  Private data members
00169     //
00170     //  fId
00171     //      This is the unique id given to this notation decl.
00172     //
00173     //  fName
00174     //      The notation's name, which identifies the type of notation it
00175     //      applies to.
00176     //
00177     //  fPublicId
00178     //      The text of the notation's public id, if any.
00179     //
00180     //  fSystemId
00181     //      The text of the notation's system id, if any.
00182     // -----------------------------------------------------------------------
00183     unsigned int    fId;
00184         XMLCh*          fName;
00185     XMLCh*          fPublicId;
00186     XMLCh*          fSystemId;
00187 };
00188 
00189 
00190 // -----------------------------------------------------------------------
00191 //  Getter methods
00192 // -----------------------------------------------------------------------
00193 inline unsigned int XMLNotationDecl::getId() const
00194 {
00195     return fId;
00196 }
00197 
00198 inline const XMLCh* XMLNotationDecl::getName() const
00199 {
00200     return fName;
00201 }
00202 
00203 inline const XMLCh* XMLNotationDecl::getPublicId() const
00204 {
00205     return fPublicId;
00206 }
00207 
00208 inline const XMLCh* XMLNotationDecl::getSystemId() const
00209 {
00210     return fSystemId;
00211 }
00212 
00213 
00214 // -----------------------------------------------------------------------
00215 //  Setter methods
00216 // -----------------------------------------------------------------------
00217 inline void XMLNotationDecl::setId(const unsigned int newId)
00218 {
00219     fId = newId;
00220 }
00221 
00222 inline void XMLNotationDecl::setPublicId(const XMLCh* const newId)
00223 {
00224     delete [] fPublicId;
00225     fPublicId = XMLString::replicate(newId);
00226 }
00227 
00228 inline void XMLNotationDecl::setSystemId(const XMLCh* const newId)
00229 {
00230     delete [] fSystemId;
00231     fSystemId = XMLString::replicate(newId);
00232 }
00233 
00234 
00235 // ---------------------------------------------------------------------------
00236 //  XMLNotationDecl: Support named pool element semantics
00237 // ---------------------------------------------------------------------------
00238 inline const XMLCh* XMLNotationDecl::getKey() const
00239 {
00240     return fName;
00241 }
00242 
00243 #endif

Generated on Tue Nov 19 09:36:35 2002 by doxygen1.3-rc1