DOMDocument.hpp Source File

00001 #ifndef DOMDocument_HEADER_GUARD_
00002 #define DOMDocument_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2001-2002 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) 2001, 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: DOMDocument.hpp,v 1.15 2003/08/20 11:31:22 gareth Exp $
00062 */
00063 
00064 #include <xercesc/util/XercesDefs.hpp>
00065 #include "DOMNode.hpp"
00066 #include "DOMDocumentRange.hpp"
00067 #include "DOMDocumentTraversal.hpp"
00068 #include "DOMXPathEvaluator.hpp"
00069 
00070 XERCES_CPP_NAMESPACE_BEGIN
00071 
00072 class DOMConfiguration;
00073 class DOMDocumentType;
00074 class DOMElement;
00075 class DOMDocumentFragment;
00076 class DOMComment;
00077 class DOMCDATASection;
00078 class DOMProcessingInstruction;
00079 class DOMAttr;
00080 class DOMEntity;
00081 class DOMEntityReference;
00082 class DOMImplementation;
00083 class DOMNodeFilter;
00084 class DOMNodeList;
00085 class DOMNotation;
00086 class DOMText;
00087 class DOMNode;
00088 
00089 
00103 class  DOMDocument: public DOMDocumentRange,
00104  public DOMXPathEvaluator,
00105  public DOMDocumentTraversal,
00106  public DOMNode {
00107 
00108 
00109 protected:
00110     // -----------------------------------------------------------------------
00111     //  Hidden constructors
00112     // -----------------------------------------------------------------------
00115     DOMDocument() {};
00117 
00118 private:
00119     // -----------------------------------------------------------------------
00120     // Unimplemented constructors and operators
00121     // -----------------------------------------------------------------------
00124     DOMDocument(const DOMDocument &);
00125     DOMDocument & operator = (const DOMDocument &);
00127 
00128 public:
00129     // -----------------------------------------------------------------------
00130     //  All constructors are hidden, just the destructor is available
00131     // -----------------------------------------------------------------------
00138     virtual ~DOMDocument() {};
00140 
00141     // -----------------------------------------------------------------------
00142     // Virtual DOMDocument interface
00143     // -----------------------------------------------------------------------
00166     virtual DOMElement     *createElement(const XMLCh *tagName) = 0;
00167 
00173     virtual DOMDocumentFragment   *createDocumentFragment() = 0;
00174 
00181     virtual DOMText         *createTextNode(const XMLCh *data) = 0;
00182 
00189     virtual DOMComment      *createComment(const XMLCh *data) = 0;
00190 
00198     virtual DOMCDATASection   *createCDATASection(const XMLCh *data) = 0;
00199 
00211     virtual DOMProcessingInstruction *createProcessingInstruction(const XMLCh *target,
00212         const XMLCh *data) = 0;
00213 
00214 
00231     virtual DOMAttr     *createAttribute(const XMLCh *name) = 0;
00232 
00233 
00251     virtual DOMEntityReference    *createEntityReference(const XMLCh *name) = 0;
00252 
00264     virtual DOMDocumentType       *getDoctype() const = 0;
00265 
00271     virtual DOMImplementation  *getImplementation() const = 0;
00272 
00278     virtual DOMElement     *getDocumentElement() const = 0;
00279 
00294     virtual DOMNodeList      *getElementsByTagName(const XMLCh *tagname) const = 0;
00295 
00297 
00300 
00399     virtual DOMNode        *importNode(DOMNode *importedNode, bool deep) = 0;
00400 
00456     virtual DOMElement         *createElementNS(const XMLCh *namespaceURI,
00457                                                   const XMLCh *qualifiedName) = 0;
00458 
00521     virtual DOMAttr        *createAttributeNS(const XMLCh *namespaceURI,
00522                                                 const XMLCh *qualifiedName) = 0;
00523 
00536     virtual DOMNodeList        *getElementsByTagNameNS(const XMLCh *namespaceURI,
00537                                                          const XMLCh *localName) const = 0;
00538 
00552     virtual  DOMElement        * getElementById(const XMLCh *elementId) const = 0;
00554 
00557 
00568     virtual const XMLCh*           getActualEncoding() const = 0;
00569 
00580     virtual void                   setActualEncoding(const XMLCh* actualEncoding) = 0;
00581 
00590     virtual const XMLCh*           getEncoding() const = 0;
00591 
00600     virtual void                   setEncoding(const XMLCh* encoding) = 0;
00601 
00611     virtual bool                   getStandalone() const = 0;
00612 
00622     virtual void                   setStandalone(bool standalone) = 0;
00623 
00633     virtual const XMLCh*           getVersion() const = 0;
00634 
00644     virtual void                   setVersion(const XMLCh* version) = 0;
00645 
00656     virtual const XMLCh*           getDocumentURI() const = 0;
00667     virtual void                   setDocumentURI(const XMLCh* documentURI) = 0;
00668 
00681     virtual bool                   getStrictErrorChecking() const = 0;
00694     virtual void                   setStrictErrorChecking(bool strictErrorChecking) = 0;
00695 
00742     virtual DOMNode* renameNode(DOMNode* n, const XMLCh* namespaceURI, const XMLCh* name) = 0;
00743 
00744 
00806     virtual DOMNode*               adoptNode(DOMNode* source) = 0;
00807 
00832     virtual void                   normalizeDocument() = 0;
00833 
00834 
00850     virtual DOMConfiguration*      getDOMConfiguration() const = 0;
00851 
00852     // -----------------------------------------------------------------------
00853     // Non-standard extension
00854     // -----------------------------------------------------------------------
00864     virtual DOMEntity     *createEntity(const XMLCh *name) = 0;
00865 
00874     virtual DOMDocumentType *createDocumentType(const XMLCh *name) = 0;
00875 
00876 
00885     virtual DOMNotation *createNotation(const XMLCh *name) = 0;
00886 
00896     virtual DOMElement         *createElementNS(const XMLCh *namespaceURI,
00897                                                   const XMLCh *qualifiedName,
00898                                                   const XMLSSize_t lineNum,
00899                                                   const XMLSSize_t columnNum) = 0;
00901 
00902 };
00903 
00904 XERCES_CPP_NAMESPACE_END
00905 
00906 #endif