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  

DOM_Document.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: DOM_Document.hpp,v $
00059  * Revision 1.12  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.11  2000/03/24 21:24:50  abagchi
00064  * Added getElementById() from patch submitted by Jeff Lewis
00065  *
00066  * Revision 1.10  2000/03/02 19:53:55  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.9  2000/02/24 20:11:27  abagchi
00072  * Swat for removing Log from API docs
00073  *
00074  * Revision 1.8  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.7  2000/02/10 19:41:16  abagchi
00080  * Added docs for createNodeIterator and createTreeWalker
00081  *
00082  * Revision 1.6  2000/02/06 07:47:28  rahulj
00083  * Year 2K copyright swat.
00084  *
00085  * Revision 1.5  2000/02/04 01:49:28  aruna1
00086  * TreeWalker and NodeIterator changes
00087  *
00088  * Revision 1.4  2000/01/22 01:38:29  andyh
00089  * Remove compiler warnings in DOM impl classes
00090  *
00091  * Revision 1.3  2000/01/05 01:16:07  andyh
00092  * DOM Level 2 core, namespace support added.
00093  *
00094  * Revision 1.2  1999/12/21 07:47:06  robweir
00095  * Patches to support Xalan, where we need to create a
00096  * "special" DOM with subclassed Nodes.
00097  *
00098  * 1. Export the NodeImpl-derived classes
00099  * 2. Ensure that their constructors have at least protected access
00100  *
00101  * Revision 1.1.1.1  1999/11/09 01:08:51  twl
00102  * Initial checkin
00103  *
00104  * Revision 1.4  1999/11/08 20:44:15  rahul
00105  * Swat for adding in Product name and CVS comment log variable.
00106  *
00107 */
00108 
00109 #ifndef DOM_Document_HEADER_GUARD_
00110 #define DOM_Document_HEADER_GUARD_
00111 
00112 #include <util/XercesDefs.hpp>
00113 #include <dom/DOM_DocumentType.hpp>
00114 #include <dom/DOM_DOMImplementation.hpp>
00115 #include <dom/DOM_Element.hpp>
00116 #include <dom/DOM_DocumentFragment.hpp>
00117 #include <dom/DOM_Comment.hpp>
00118 #include <dom/DOM_CDATASection.hpp>
00119 #include <dom/DOM_ProcessingInstruction.hpp>
00120 #include <dom/DOM_Attr.hpp>
00121 #include <dom/DOM_Entity.hpp>
00122 #include <dom/DOM_EntityReference.hpp>
00123 #include <dom/DOM_NodeList.hpp>
00124 #include <dom/DOM_Notation.hpp>
00125 #include <dom/DOM_Text.hpp>
00126 #include <dom/DOM_Node.hpp>
00127 #include <dom/DOM_NodeIterator.hpp>
00128 #include <dom/DOM_TreeWalker.hpp>
00129 #include <dom/DOM_XMLDecl.hpp>
00130 
00131 class DocumentImpl;
00132 class NodeIteratorImpl;
00133 
00134 
00147 class  DOM_Document: public DOM_Node {
00148 
00149 public:
00151     //@{
00161     DOM_Document();
00162 
00169     DOM_Document(const DOM_Document &other);
00175     DOM_Document & operator = (const DOM_Document &other);
00176 
00190     DOM_Document & operator = (const DOM_NullPtr *val);
00191 
00192 
00193 
00194     //@}
00196   //@{
00197     
00210     ~DOM_Document();
00211 
00212   //@}
00214   //@{
00215 
00228     static DOM_Document   createDocument();
00229 
00237     DOM_Entity     createEntity(const DOMString &name);
00238 
00251     DOM_Element     createElement(const DOMString &tagName);
00252 
00270     DOM_Element     createElement(const XMLCh *tagName);
00271 
00272 
00279     DOM_DocumentFragment   createDocumentFragment();
00280 
00288     DOM_Text         createTextNode(const DOMString &data);
00289 
00297     DOM_Comment      createComment(const DOMString &data);
00298 
00308     DOM_CDATASection   createCDATASection(const DOMString &data);
00309 
00317     DOM_DocumentType createDocumentType(const DOMString &name);
00318 
00319 
00329     DOM_Notation createNotation(const DOMString &name);
00330 
00331 
00343     DOM_ProcessingInstruction createProcessingInstruction(const DOMString &target,
00344         const DOMString &data);
00345 
00346 
00363     DOM_Attr     createAttribute(const DOMString &name);
00364 
00365 
00376     DOM_EntityReference    createEntityReference(const DOMString &name);
00377 
00378 
00403 
00404     DOM_NodeIterator createNodeIterator(DOM_Node root, 
00405                                         unsigned long whatToShow, 
00406                                         DOM_NodeFilter*  filter, 
00407                                         bool entityReferenceExpansion);
00438 
00439     DOM_TreeWalker  createTreeWalker(DOM_Node root, 
00440                                      unsigned long whatToShow, 
00441                                      DOM_NodeFilter*  filter, 
00442                                      bool entityReferenceExpansion);
00443 
00458 
00459     DOM_XMLDecl createXMLDecl(const DOMString& version,
00460                             const DOMString& encoding,
00461                             const DOMString& standalone);
00462 
00463     //@}
00465     //@{
00475     DOM_DocumentType       getDoctype() const;
00476 
00477 
00478 
00482     DOM_DOMImplementation  &getImplementation() const;
00483 
00484 
00488     DOM_Element     getDocumentElement() const;
00489 
00504     DOM_NodeList           getElementsByTagName(const DOMString &tagname) const;
00505 
00506     //@}
00508     //@{
00509 
00532     DOM_Node            importNode(const DOM_Node &importedNode, bool deep);
00533 
00556     DOM_Element         createElementNS(const DOMString &namespaceURI,
00557     const DOMString &qualifiedName);
00558 
00587     DOM_Attr            createAttributeNS(const DOMString &namespaceURI,
00588     const DOMString &qualifiedName);
00589 
00606     DOM_NodeList        getElementsByTagNameNS(const DOMString &namespaceURI,
00607     const DOMString &localName) const;
00608 
00624     DOM_Element         getElementById(const DOMString &elementId);
00625 
00626     //@}
00627 
00629     //@{
00630 
00640     void                 putIdentifier(const DOMString &elementId, const DOM_Element &ele);
00641 
00642     //@}
00643 protected:
00644     DOM_Document (DocumentImpl *impl);
00645 
00646     friend class DOM_Node;
00647     friend class NodeIteratorImpl;
00648     friend class DOM_DOMImplementation;
00649 
00650 };
00651 
00652 
00653 #endif


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