DOM_NamedNodeMap.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: DOM_NamedNodeMap.hpp,v $

00059  * Revision 1.13  2000/06/07 22:49:40  andyh

00060  * Memory usage reduction:  DOM NamedNodeMaps for attributes are allocated

00061  * only for elements that actually have attributes.  By Joe Polastre.

00062  *
00063  * Revision 1.12  2000/03/11 03:19:13  chchou

00064  * Fix bug # 19, add const keyword to API

00065  *
00066  * Revision 1.11  2000/03/02 19:53:56  roddey

00067  * This checkin includes many changes done while waiting for the

00068  * 1.1.0 code to be finished. I can't list them all here, but a list is

00069  * available elsewhere.

00070  *
00071  * Revision 1.10  2000/02/24 20:11:28  abagchi

00072  * Swat for removing Log from API docs

00073  *
00074  * Revision 1.9  2000/02/17 17:47:24  andyh

00075  * Update Doc++ API comments

00076  * NameSpace update to track W3C

00077  * Changes were made by Chih Hsiang Chou

00078  *
00079  * Revision 1.8  2000/02/15 23:17:36  andyh

00080  * Update Doc++ API comments

00081  * NameSpace bugfix and update to track W3C

00082  * Chih Hsiang Chou

00083  *
00084  * Revision 1.7  2000/02/10 20:20:42  abagchi

00085  * Added docs for assignment operators

00086  *
00087  * Revision 1.6  2000/02/10 20:19:24  abagchi

00088  * Added docs for equality operators

00089  *
00090  * Revision 1.5  2000/02/06 07:47:30  rahulj

00091  * Year 2K copyright swat.

00092  *
00093  * Revision 1.4  2000/02/04 01:49:28  aruna1

00094  * TreeWalker and NodeIterator changes

00095  *
00096  * Revision 1.3  2000/01/22 01:38:29  andyh

00097  * Remove compiler warnings in DOM impl classes

00098  *
00099  * Revision 1.2  2000/01/05 01:16:07  andyh

00100  * DOM Level 2 core, namespace support added.

00101  *
00102  * Revision 1.1.1.1  1999/11/09 01:08:59  twl

00103  * Initial checkin

00104  *
00105  * Revision 1.3  1999/11/08 20:44:18  rahul

00106  * Swat for adding in Product name and CVS comment log variable.

00107  *
00108  */
00109 
00110 #ifndef DOM_NamedNodeMap_HEADER_GUARD_
00111 #define DOM_NamedNodeMap_HEADER_GUARD_
00112 
00113 #include <util/XercesDefs.hpp>
00114 
00115 #include <dom/DOM_Node.hpp>
00116 class NamedNodeMapImpl;
00117 
00129 class  DOM_NamedNodeMap {
00130 private:
00131     void     *fImpl;
00132     short    flagElem;
00133 
00134     static const unsigned short NNM_ELEMENT;
00135     static const unsigned short NNM_OTHER;  
00136     
00137 public:
00140 
00148     DOM_NamedNodeMap();
00149 
00156     DOM_NamedNodeMap(const DOM_NamedNodeMap &other);
00157 
00163     DOM_NamedNodeMap & operator = (const DOM_NamedNodeMap &other);
00164 
00170     DOM_NamedNodeMap & operator = (const DOM_NullPtr *other);
00171 
00173 
00175 
00186     ~DOM_NamedNodeMap();
00187     
00189 
00192 
00200     bool operator == (const DOM_NamedNodeMap &other) const;
00201 
00210     bool operator != (const DOM_NamedNodeMap &other) const;
00211 
00212 
00220     bool operator == (const DOM_NullPtr *p) const;
00221 
00229     bool operator != (const DOM_NullPtr *p) const;
00230 
00232 
00235 
00261     DOM_Node               setNamedItem(DOM_Node arg);
00262 
00264 
00266 
00278     DOM_Node               item(unsigned int index) const;
00279 
00288     DOM_Node               getNamedItem(const DOMString &name) const;
00289 
00296     unsigned int           getLength() const;
00297 
00299 
00301 
00317     DOM_Node               removeNamedItem(const DOMString &name);
00318 
00320 
00322 
00335     DOM_Node               getNamedItemNS(const DOMString &namespaceURI,
00336     const DOMString &localName);
00337 
00362     DOM_Node               setNamedItemNS(DOM_Node arg);
00363 
00387     DOM_Node               removeNamedItemNS(const DOMString &namespaceURI,
00388     const DOMString &localName);
00389 
00391 
00392  protected:
00393 
00394     DOM_NamedNodeMap(NamedNodeMapImpl *impl);
00395     DOM_NamedNodeMap(NodeImpl *impl);
00396 
00397     friend class DOM_DocumentType;
00398     friend class DOM_Node;
00399 
00400 
00401 };
00402 
00403 #endif
00404