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  

DocumentImpl.hpp

Go to the documentation of this file.
00001 #ifndef DocumentImpl_HEADER_GUARD_
00002 #define DocumentImpl_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 1999, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * $Id: DocumentImpl.hpp,v 1.18 2000/05/13 03:51:17 andyh Exp $
00062  */
00063 
00064 //
00065 //  This file is part of the internal implementation of the C++ XML DOM.
00066 //  It should NOT be included or used directly by application programs.
00067 //
00068 //  Applications should include the file <dom/DOM.hpp> for the entire
00069 //  DOM API, or DOM_*.hpp for individual DOM classes, where the class
00070 //  name is substituded for the *.
00071 //
00072 
00073 #include <util/XercesDefs.hpp>
00074 #include "ParentNode.hpp"
00075 #include "DOM_Node.hpp"
00076 #include "DOM_Element.hpp"
00077 #include "util/RefVectorOf.hpp"
00078 #include "util/RefHashTableOf.hpp"
00079 #include "XMLDeclImpl.hpp"
00080 
00081 class DocumentTypeImpl;
00082 class ElementImpl;
00083 class AttrImpl;
00084 class CDATASectionImpl;
00085 class CommentImpl;
00086 class DeepNodeListImpl;
00087 class DocumentFragmentImpl;
00088 class DocumentTypeImpl;
00089 class DStringPool;
00090 class EntityImpl;
00091 class EntityReferenceImpl;
00092 class NotationImpl;
00093 class ProcessingInstructionImpl;
00094 class TextImpl;
00095 class NodeIteratorImpl;
00096 class TreeWalkerImpl;
00097 class DOM_NodeFilter;
00098 class NodeFilterImpl;
00099 class DOM_DOMImplementation;
00100 class DOMString;
00101 class NodeIDMap;
00102 
00103 typedef RefVectorOf<NodeIteratorImpl> NodeIterators;
00104 typedef RefVectorOf<TreeWalkerImpl> TreeWalkers;
00105 
00106 
00107 class  DocumentImpl: public ParentNode {
00108 private:
00109     // -----------------------------------------------------------------------
00110     //  Private data types
00111     // -----------------------------------------------------------------------
00112 
00113     void setDocumentType(DocumentTypeImpl *doctype);
00114 
00115     DocumentTypeImpl            *docType;
00116     ElementImpl                 *docElement;
00117     DStringPool                 *namePool;
00118     NodeIDMap                   *fNodeIDMap;      // for use by GetElementsById().
00119 
00120     NodeIterators               *iterators;
00121     TreeWalkers                 *treeWalkers;
00122     friend class NodeIteratorImpl;
00123     friend class TreeWalkerImpl;
00124     friend class DOMParser;
00125 
00126 public:
00127     DocumentImpl();
00128     DocumentImpl(const DOMString &namespaceURI,     //DOM Level 2
00129     const DOMString &qualifiedName, DocumentTypeImpl *doctype);
00130     virtual ~DocumentImpl();
00131     virtual bool isDocumentImpl();   // RTTI replacement function
00132 
00133     virtual NodeImpl            *cloneNode(bool deep);
00134     virtual DOMString getNodeName();
00135     virtual short getNodeType();
00136     virtual DocumentImpl * getOwnerDocument();
00137     virtual AttrImpl            *createAttribute(const DOMString &name);
00138     virtual CDATASectionImpl    *createCDATASection(const DOMString &data);
00139     virtual CommentImpl         *createComment(const DOMString &data);
00140     virtual DocumentFragmentImpl *createDocumentFragment();
00141     virtual DocumentTypeImpl    *createDocumentType(const DOMString &name);
00142     virtual DocumentTypeImpl    *createDocumentType(const DOMString &qName,
00143                                                     const DOMString &publicId,
00144                                                     const DOMString &systemId);
00145     virtual ElementImpl         *createElement(const DOMString & tagName);
00146     virtual ElementImpl         *createElement(const XMLCh *tagName);
00147     virtual EntityImpl          *createEntity(const DOMString & name);
00148     virtual EntityReferenceImpl *createEntityReference(const DOMString & name);
00149     virtual NotationImpl        *createNotation(const DOMString & name);
00150     virtual ProcessingInstructionImpl *createProcessingInstruction(const DOMString & target, const DOMString & data);
00151     virtual TextImpl            *createTextNode(const DOMString & data);
00152     virtual DocumentTypeImpl    *getDoctype();
00153     virtual ElementImpl         *getDocumentElement();
00154     virtual DeepNodeListImpl    *getElementsByTagName(const DOMString & tagname);
00155     virtual NodeImpl            *insertBefore(NodeImpl *newChild, NodeImpl *refChild);
00156     static  bool                isXMLName(const DOMString & s);
00157     virtual void                referenced();
00158     virtual NodeImpl            *removeChild(NodeImpl *oldChild);
00159     virtual void                setNodeValue(const DOMString & x);
00160     virtual void                unreferenced();
00161     static  NodeIteratorImpl*   createNodeIterator(DOM_Node root, unsigned long whatToShow, DOM_NodeFilter* filter, bool entityReferenceExpansion);
00162     static  TreeWalkerImpl*     createTreeWalker(DOM_Node root, unsigned long whatToShow, DOM_NodeFilter* filter, bool entityReferenceExpansion);
00163     virtual XMLDeclImpl*        createXMLDecl(const DOMString& version, const DOMString& encoding, const DOMString& standalone);
00164 
00165 
00166     //Introduced in DOM Level 2
00167     virtual NodeImpl            *importNode(NodeImpl *source, bool deep);
00168     virtual ElementImpl         *createElementNS(const DOMString &namespaceURI,
00169                                                  const DOMString &qualifiedName);
00170     virtual AttrImpl            *createAttributeNS(const DOMString &namespaceURI,
00171                                                  const DOMString &qualifiedName);
00172     virtual DeepNodeListImpl    *getElementsByTagNameNS(const DOMString &namespaceURI,
00173                                                   const DOMString &localName);
00174     virtual ElementImpl         *getElementById(const DOMString &elementId);
00175 
00176     //Return the index > 0 of ':' in the given qualified name qName="prefix:localName".
00177     //Return 0 if there is no ':', or -1 if qName is malformed such as ":abcd".
00178     static  int                 indexofQualifiedName(const DOMString & qName);
00179     static  bool                isKidOK(NodeImpl *parent, NodeImpl *child);
00180 
00181     inline NodeIDMap *          getNodeIDMap() {return fNodeIDMap;};
00182 };
00183 
00184 #endif


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