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_Node.hpp,v $
00059 * Revision 1.9 2000/04/25 20:29:33 aruna1
00060 * DOM_XMLDecl type node introduced to get the information of the
00061 * XML Declaration in a document and store it part of the tree
00062 *
00063 * Revision 1.8 2000/04/19 02:26:16 aruna1
00064 * Full support for DOM_EntityReference, DOM_Entity and DOM_DocumentType introduced
00065 *
00066 * Revision 1.7 2000/03/11 02:17:19 chchou
00067 * Fix bug # 29 to have the spefified flag set correctly for AttrImpl.
00068 *
00069 * Revision 1.6 2000/03/02 19:53:56 roddey
00070 * This checkin includes many changes done while waiting for the
00071 * 1.1.0 code to be finished. I can't list them all here, but a list is
00072 * available elsewhere.
00073 *
00074 * Revision 1.5 2000/02/24 20:11:28 abagchi
00075 * Swat for removing Log from API docs
00076 *
00077 * Revision 1.4 2000/02/17 17:47:25 andyh
00078 * Update Doc++ API comments
00079 * NameSpace update to track W3C
00080 * Changes were made by Chih Hsiang Chou
00081 *
00082 * Revision 1.3 2000/02/06 07:47:30 rahulj
00083 * Year 2K copyright swat.
00084 *
00085 * Revision 1.2 2000/01/05 01:16:07 andyh
00086 * DOM Level 2 core, namespace support added.
00087 *
00088 * Revision 1.1.1.1 1999/11/09 01:08:59 twl
00089 * Initial checkin
00090 *
00091 * Revision 1.4 1999/11/08 20:44:19 rahul
00092 * Swat for adding in Product name and CVS comment log variable.
00093 *
00094 */
00095
00096 #ifndef DOM_Node_HEADER_GUARD_
00097 #define DOM_Node_HEADER_GUARD_
00098
00099 #include <util/XercesDefs.hpp>
00100 #include <dom/DOMString.hpp>
00101
00102 class DOM_NodeList;
00103 class DOM_NamedNodeMap;
00104 class DOM_Document;
00105 class NodeImpl;
00106
00107 class DOM_NullPtr; // A dummy class, with no implementation, that is
00108 // used as in overloaded functions as a way to
00109 // pass 0 or null.
00110
00130 class DOM_Node {
00131
00132 public:
00134 //@{
00143 DOM_Node();
00144
00150 DOM_Node(const DOM_Node &other);
00151
00157 DOM_Node & operator = (const DOM_Node &other);
00158
00172 DOM_Node & operator = (const DOM_NullPtr *val);
00173
00174 //@}
00176 //@{
00182 ~DOM_Node();
00183
00184 //@}
00186 //@{
00198 bool operator == (const DOM_Node & other)const;
00199
00205 bool operator == (const DOM_NullPtr *other) const;
00206
00211 bool operator != (const DOM_Node & other) const;
00212
00218 bool operator != (const DOM_NullPtr * other) const;
00219
00220
00221 enum NodeType {
00222 ELEMENT_NODE = 1,
00223 ATTRIBUTE_NODE = 2,
00224 TEXT_NODE = 3,
00225 CDATA_SECTION_NODE = 4,
00226 ENTITY_REFERENCE_NODE = 5,
00227 ENTITY_NODE = 6,
00228 PROCESSING_INSTRUCTION_NODE = 7,
00229 COMMENT_NODE = 8,
00230 DOCUMENT_NODE = 9,
00231 DOCUMENT_TYPE_NODE = 10,
00232 DOCUMENT_FRAGMENT_NODE = 11,
00233 NOTATION_NODE = 12,
00234 XML_DECL_NODE = 13
00235 };
00236
00237 //@}
00239 //@{
00240
00244 DOMString getNodeName() const;
00245
00256 DOMString getNodeValue() const;
00257
00261 short getNodeType() const;
00262
00272 DOM_Node getParentNode() const;
00273
00287 DOM_NodeList getChildNodes() const;
00293 DOM_Node getFirstChild() const;
00294
00300 DOM_Node getLastChild() const;
00301
00307 DOM_Node getPreviousSibling() const;
00308
00314 DOM_Node getNextSibling() const;
00315
00320 DOM_NamedNodeMap getAttributes() const;
00321
00334 DOM_Document getOwnerDocument() const;
00335
00344 void *getUserData() const;
00345
00346 //@}
00348 //@{
00349
00368 DOM_Node cloneNode(bool deep) const;
00369
00370 //@}
00372 //@{
00373
00400 DOM_Node insertBefore(const DOM_Node &newChild,
00401 const DOM_Node &refChild);
00402
00403
00426 DOM_Node replaceChild(const DOM_Node &newChild,
00427 const DOM_Node &oldChild);
00439 DOM_Node removeChild(const DOM_Node &oldChild);
00440
00460 DOM_Node appendChild(const DOM_Node &newChild);
00461
00462 //@}
00464 //@{
00465
00473 bool hasChildNodes() const;
00474
00475
00488 bool isNull() const;
00489
00490 //@}
00492 //@{
00493
00494
00508 void setNodeValue(const DOMString &nodeValue);
00509
00527 void setUserData(void *p);
00528
00529 //@}
00531 //@{
00532
00554 void normalize();
00555
00572 bool supports(const DOMString &feature,
00573 const DOMString &version) const;
00574
00591 DOMString getNamespaceURI() const;
00592
00600 DOMString getPrefix() const;
00601
00612 DOMString getLocalName() const;
00613
00647 void setPrefix(const DOMString &prefix);
00648
00649 //@}
00650
00651 protected:
00652 NodeImpl *fImpl;
00653
00654 DOM_Node(NodeImpl *);
00655
00656 friend class DOM_Document;
00657 friend class DocumentImpl;
00658 friend class TreeWalkerImpl;
00659 friend class NodeIteratorImpl;
00660 friend class DOM_NamedNodeMap;
00661 friend class DOM_NodeList;
00662 friend class DOMParser;
00663 friend class DOM_Entity;
00664
00665 };
00666
00667
00668 #endif
00669