DOM_Document.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2001 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  * $Id: DOM_Document.hpp,v 1.16 2001/05/11 13:25:20 tng Exp $
00059 */
00060 
00061 #ifndef DOM_Document_HEADER_GUARD_
00062 #define DOM_Document_HEADER_GUARD_
00063 
00064 #include <util/XercesDefs.hpp>
00065 #include <dom/DOM_DocumentType.hpp>
00066 #include <dom/DOM_DOMImplementation.hpp>
00067 #include <dom/DOM_Element.hpp>
00068 #include <dom/DOM_DocumentFragment.hpp>
00069 #include <dom/DOM_Comment.hpp>
00070 #include <dom/DOM_CDATASection.hpp>
00071 #include <dom/DOM_ProcessingInstruction.hpp>
00072 #include <dom/DOM_Attr.hpp>
00073 #include <dom/DOM_Entity.hpp>
00074 #include <dom/DOM_EntityReference.hpp>
00075 #include <dom/DOM_NodeList.hpp>
00076 #include <dom/DOM_Notation.hpp>
00077 #include <dom/DOM_Text.hpp>
00078 #include <dom/DOM_Node.hpp>
00079 #include <dom/DOM_NodeIterator.hpp>
00080 #include <dom/DOM_TreeWalker.hpp>
00081 #include <dom/DOM_XMLDecl.hpp>
00082 #include <dom/DOM_Range.hpp>
00083 
00084 class DocumentImpl;
00085 class NodeIteratorImpl;
00086 
00087 
00100 class  DOM_Document: public DOM_Node {
00101 
00102 public:
00105 
00114     DOM_Document();
00115 
00122     DOM_Document(const DOM_Document &other);
00128     DOM_Document & operator = (const DOM_Document &other);
00129 
00143     DOM_Document & operator = (const DOM_NullPtr *val);
00144 
00145 
00146 
00148 
00150     
00163     ~DOM_Document();
00164 
00166 
00168 
00181     static DOM_Document   createDocument();
00182 
00190     DOM_Entity     createEntity(const DOMString &name);
00191 
00204     DOM_Element     createElement(const DOMString &tagName);
00205 
00223     DOM_Element     createElement(const XMLCh *tagName);
00224 
00225 
00232     DOM_DocumentFragment   createDocumentFragment();
00233 
00241     DOM_Text         createTextNode(const DOMString &data);
00242 
00250     DOM_Comment      createComment(const DOMString &data);
00251 
00261     DOM_CDATASection   createCDATASection(const DOMString &data);
00262 
00270     DOM_DocumentType createDocumentType(const DOMString &name);
00271 
00272 
00282     DOM_Notation createNotation(const DOMString &name);
00283 
00284 
00296     DOM_ProcessingInstruction createProcessingInstruction(const DOMString &target,
00297         const DOMString &data);
00298 
00299 
00316     DOM_Attr     createAttribute(const DOMString &name);
00317 
00318 
00329     DOM_EntityReference    createEntityReference(const DOMString &name);
00330 
00331 
00356 
00357     DOM_NodeIterator createNodeIterator(DOM_Node root,
00358                                         unsigned long whatToShow,
00359                                         DOM_NodeFilter*  filter,
00360                                         bool entityReferenceExpansion);
00391 
00392     DOM_TreeWalker  createTreeWalker(DOM_Node root,
00393                                      unsigned long whatToShow,
00394                                      DOM_NodeFilter*  filter,
00395                                      bool entityReferenceExpansion);
00396 
00411 
00412     DOM_XMLDecl createXMLDecl(const DOMString& version,
00413                             const DOMString& encoding,
00414                             const DOMString& standalone);
00415 
00426     DOM_Range    createRange();
00427 
00429 
00431 
00440     DOM_DocumentType       getDoctype() const;
00441 
00442 
00443 
00447     DOM_DOMImplementation  &getImplementation() const;
00448 
00449 
00453     DOM_Element     getDocumentElement() const;
00454 
00469     DOM_NodeList           getElementsByTagName(const DOMString &tagname) const;
00470 
00472 
00474 
00497     DOM_Node            importNode(const DOM_Node &importedNode, bool deep);
00498 
00521     DOM_Element         createElementNS(const DOMString &namespaceURI,
00522     const DOMString &qualifiedName);
00523 
00552     DOM_Attr            createAttributeNS(const DOMString &namespaceURI,
00553     const DOMString &qualifiedName);
00554 
00571     DOM_NodeList        getElementsByTagNameNS(const DOMString &namespaceURI,
00572     const DOMString &localName) const;
00573 
00589     DOM_Element         getElementById(const DOMString &elementId);
00590 
00609     void setErrorChecking(bool check);
00610 
00614     bool getErrorChecking();
00615 
00617 
00618 protected:
00619     DOM_Document (DocumentImpl *impl);
00620 
00621     friend class DOM_Node;
00622     friend class DocumentImpl;
00623     friend class NodeIteratorImpl;
00624     friend class DOM_DOMImplementation;
00625 
00626 };
00627 
00628 
00629 #endif