DOMDocument.hpp

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * $Id: DOMDocument.hpp 932889 2010-04-11 13:10:10Z borisk $
*/

#if !defined(XERCESC_INCLUDE_GUARD_DOMDOCUMENT_HPP)
#define XERCESC_INCLUDE_GUARD_DOMDOCUMENT_HPP

#include <xercesc/util/XercesDefs.hpp>
#include <xercesc/dom/DOMNode.hpp>
#include <xercesc/dom/DOMDocumentRange.hpp>
#include <xercesc/dom/DOMDocumentTraversal.hpp>
#include <xercesc/dom/DOMXPathEvaluator.hpp>

XERCES_CPP_NAMESPACE_BEGIN

class DOMConfiguration;
class DOMDocumentType;
class DOMElement;
class DOMDocumentFragment;
class DOMComment;
class DOMCDATASection;
class DOMProcessingInstruction;
class DOMAttr;
class DOMEntity;
class DOMEntityReference;
class DOMImplementation;
class DOMNodeFilter;
class DOMNodeList;
class DOMNotation;
class DOMText;
class DOMNode;


class CDOM_EXPORT DOMDocument: public DOMDocumentRange,
 public DOMXPathEvaluator,
 public DOMDocumentTraversal,
 public DOMNode {


protected:
    // -----------------------------------------------------------------------
    //  Hidden constructors
    // -----------------------------------------------------------------------
    DOMDocument() {};

private:
    // -----------------------------------------------------------------------
    // Unimplemented constructors and operators
    // -----------------------------------------------------------------------
    DOMDocument(const DOMDocument &);
    DOMDocument & operator = (const DOMDocument &);

public:
    // -----------------------------------------------------------------------
    //  All constructors are hidden, just the destructor is available
    // -----------------------------------------------------------------------
    virtual ~DOMDocument() {};

    // -----------------------------------------------------------------------
    // Virtual DOMDocument interface
    // -----------------------------------------------------------------------
    virtual DOMElement     *createElement(const XMLCh *tagName) = 0;

    virtual DOMDocumentFragment   *createDocumentFragment() = 0;

    virtual DOMText         *createTextNode(const XMLCh *data) = 0;

    virtual DOMComment      *createComment(const XMLCh *data) = 0;

    virtual DOMCDATASection   *createCDATASection(const XMLCh *data) = 0;

    virtual DOMProcessingInstruction *createProcessingInstruction(const XMLCh *target,
        const XMLCh *data) = 0;


    virtual DOMAttr     *createAttribute(const XMLCh *name) = 0;


    virtual DOMEntityReference    *createEntityReference(const XMLCh *name) = 0;

    virtual DOMDocumentType       *getDoctype() const = 0;

    virtual DOMImplementation  *getImplementation() const = 0;

    virtual DOMElement     *getDocumentElement() const = 0;

    virtual DOMNodeList      *getElementsByTagName(const XMLCh *tagname) const = 0;



    virtual DOMNode        *importNode(const DOMNode *importedNode, bool deep) = 0;

    virtual DOMElement         *createElementNS(const XMLCh *namespaceURI,
                                                      const XMLCh *qualifiedName) = 0;

    virtual DOMAttr        *createAttributeNS(const XMLCh *namespaceURI,
                                                    const XMLCh *qualifiedName) = 0;

    virtual DOMNodeList        *getElementsByTagNameNS(const XMLCh *namespaceURI,
                                                             const XMLCh *localName) const = 0;

    virtual  DOMElement        * getElementById(const XMLCh *elementId) const = 0;


    virtual const XMLCh*           getInputEncoding() const = 0;

    virtual const XMLCh*           getXmlEncoding() const = 0;

    virtual bool                   getXmlStandalone() const = 0;

    virtual void                   setXmlStandalone(bool standalone) = 0;

    virtual const XMLCh*           getXmlVersion() const = 0;

    virtual void                   setXmlVersion(const XMLCh* version) = 0;

    virtual const XMLCh*           getDocumentURI() const = 0;
    virtual void                   setDocumentURI(const XMLCh* documentURI) = 0;

    virtual bool                   getStrictErrorChecking() const = 0;
    virtual void                   setStrictErrorChecking(bool strictErrorChecking) = 0;

    virtual DOMNode* renameNode(DOMNode* n, const XMLCh* namespaceURI, const XMLCh* qualifiedName) = 0;


    virtual DOMNode*               adoptNode(DOMNode* source) = 0;

    virtual void                   normalizeDocument() = 0;


    virtual DOMConfiguration*      getDOMConfig() const = 0;


    // -----------------------------------------------------------------------
    // Non-standard extension
    // -----------------------------------------------------------------------
    virtual DOMEntity     *createEntity(const XMLCh *name) = 0;

    virtual DOMDocumentType *createDocumentType(const XMLCh *name) = 0;

    /***
     * Provide default implementation to maintain source code compatibility
     ***/
    virtual DOMDocumentType* createDocumentType(const XMLCh *qName,
                                                const XMLCh*,  //publicId,
                                                const XMLCh*   //systemId
                                               )
    {
        return createDocumentType(qName);
    }

    virtual DOMNotation *createNotation(const XMLCh *name) = 0;

    virtual DOMElement *createElementNS(const XMLCh *namespaceURI,
                                        const XMLCh *qualifiedName,
                                        const XMLFileLoc lineNum,
                                        const XMLFileLoc columnNum) = 0;

};

XERCES_CPP_NAMESPACE_END

#endif