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