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

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XMLRefInfo.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: XMLRefInfo.hpp,v $
00059  * Revision 1.4  2000/02/24 20:00:23  abagchi
00060  * Swat for removing Log from API docs
00061  *
00062  * Revision 1.3  2000/02/15 01:21:31  roddey
00063  * Some initial documentation improvements. More to come...
00064  *
00065  * Revision 1.2  2000/02/06 07:47:49  rahulj
00066  * Year 2K copyright swat.
00067  *
00068  * Revision 1.1.1.1  1999/11/09 01:08:37  twl
00069  * Initial checkin
00070  *
00071  * Revision 1.2  1999/11/08 20:44:40  rahul
00072  * Swat for adding in Product name and CVS comment log variable.
00073  *
00074  */
00075 
00076 
00077 #if !defined(XMLIDREFINFO_HPP)
00078 #define XMLIDREFINFO_HPP
00079 
00080 
00095 class  XMLRefInfo
00096 {
00097 public :
00098     // -----------------------------------------------------------------------
00099     //  Constructors and Destructor
00100     // -----------------------------------------------------------------------
00101 
00103     //@{
00104     XMLRefInfo
00105     (
00106         const   XMLCh* const    refName
00107         , const bool            fDeclared = false
00108         , const bool            fUsed = false
00109     );
00110     //@}
00111 
00113     //@{
00114     ~XMLRefInfo();
00115     //@}
00116 
00117 
00118     // -----------------------------------------------------------------------
00119     //  Getter methods
00120     // -----------------------------------------------------------------------
00121     bool getDeclared() const;
00122     const XMLCh* getRefName() const;
00123     bool getUsed() const;
00124 
00125 
00126     // -----------------------------------------------------------------------
00127     //  Setter methods
00128     // -----------------------------------------------------------------------
00129     void setDeclared(const bool newValue);
00130     void setUsed(const bool newValue);
00131 
00132 
00133     // -----------------------------------------------------------------------
00134     //  Support hash table semantics
00135     // -----------------------------------------------------------------------
00136     XMLCh* getKey() const;
00137 
00138 
00139 private :
00140     // -----------------------------------------------------------------------
00141     //  Unimplemented constructors and operators
00142     // -----------------------------------------------------------------------
00143     XMLRefInfo();
00144     XMLRefInfo(const XMLRefInfo&);
00145     void operator=(XMLRefInfo&);
00146 
00147 
00148     // -----------------------------------------------------------------------
00149     //  Private data members
00150     //
00151     //  fDeclared
00152     //      The name was declared somewhere as an ID attribute.
00153     //
00154     //  fRefName
00155     //      The name of the ref that this object represents. This is not a
00156     //      name of the attribute, but of the value of an ID or IDREF attr
00157     //      in content.
00158     //
00159     //  fUsed
00160     //      The name was used somewhere in an IDREF/IDREFS attribute. If this
00161     //      is true, but fDeclared is false, then the ref does not refer to
00162     //      a declared ID.
00163     // -----------------------------------------------------------------------
00164     bool        fDeclared;
00165     XMLCh*      fRefName;
00166     bool        fUsed;
00167 };
00168 
00169 
00170 // ---------------------------------------------------------------------------
00171 //  XMLRefInfo: Constructors and Destructor
00172 // ---------------------------------------------------------------------------
00173 inline XMLRefInfo::XMLRefInfo(  const   XMLCh* const    refName
00174                                 , const bool            declared
00175                                 , const bool            used) :
00176     fDeclared(declared)
00177     , fRefName(XMLString::replicate(refName))
00178     , fUsed(used)
00179 {
00180 }
00181 
00182 inline XMLRefInfo::~XMLRefInfo()
00183 {
00184     delete [] fRefName;
00185 }
00186 
00187 
00188 // ---------------------------------------------------------------------------
00189 //  XMLRefInfo: Getter methods
00190 // ---------------------------------------------------------------------------
00191 inline bool XMLRefInfo::getDeclared() const
00192 {
00193     return fDeclared;
00194 }
00195 
00196 inline const XMLCh* XMLRefInfo::getRefName() const
00197 {
00198     return fRefName;
00199 }
00200 
00201 inline bool XMLRefInfo::getUsed() const
00202 {
00203     return fUsed;
00204 }
00205 
00206 
00207 // ---------------------------------------------------------------------------
00208 //  XMLRefInfo: Setter methods
00209 // ---------------------------------------------------------------------------
00210 inline void XMLRefInfo::setDeclared(const bool newValue)
00211 {
00212     fDeclared = newValue;
00213 }
00214 
00215 inline void XMLRefInfo::setUsed(const bool newValue)
00216 {
00217     fUsed = newValue;
00218 }
00219 
00220 
00221 // ---------------------------------------------------------------------------
00222 //  XMLRefInfo: Support hash table semantics
00223 // ---------------------------------------------------------------------------
00224 inline XMLCh* XMLRefInfo::getKey() const
00225 {
00226     return fRefName;
00227 }
00228 
00229 #endif


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