Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

             

---

XalanDocument.hpp

Go to the documentation of this file.

/*
 * Copyright 1999-2004 The Apache Software Foundation.
 *
 * Licensed 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.
 */
#if !defined(XALANDOCUMENT_HEADER_GUARD_1357924680)
#define XALANDOCUMENT_HEADER_GUARD_1357924680



#include <xalanc/XalanDOM/XalanDOMDefinitions.hpp>
#include <xalanc/XalanDOM/XalanNode.hpp>



XALAN_CPP_NAMESPACE_BEGIN



class XalanAttr;
class XalanCDATASection;
class XalanComment;
class XalanDocumentFragment;
class XalanDocumentType;
class XalanDOMImplementation;
class XalanElement;
class XalanEntityReference;
class XalanProcessingInstruction;
class XalanText;



/*
 * <meta name="usage" content="experimental"/>
 *
 * Base class for the DOM Document interface.
 *
 * This class is experimental and subject to change!!
 */

class XALAN_DOM_EXPORT XalanDocument : public XalanNode
{
public:

    XalanDocument();

    virtual
    ~XalanDocument();

    // These interfaces are inherited from XalanNode...

    virtual const XalanDOMString&
    getNodeName() const = 0;

    virtual const XalanDOMString&
    getNodeValue() const = 0;

    virtual NodeType
    getNodeType() const = 0;

    virtual XalanNode*
    getParentNode() const = 0;

    virtual const XalanNodeList*
    getChildNodes() const = 0;

    virtual XalanNode*
    getFirstChild() const = 0;

    virtual XalanNode*
    getLastChild() const = 0;

    virtual XalanNode*
    getPreviousSibling() const = 0;

    virtual XalanNode*
    getNextSibling() const = 0;

    virtual const XalanNamedNodeMap*
    getAttributes() const = 0;

    virtual XalanDocument*
    getOwnerDocument() const = 0;



#if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
    virtual XalanNode*
#else
    virtual XalanDocument*
#endif
    cloneNode(bool deep) const = 0;



    virtual XalanNode*
    insertBefore(
            XalanNode*  newChild,
            XalanNode*  refChild) = 0;

    virtual XalanNode*
    replaceChild(
            XalanNode*  newChild,
            XalanNode*  oldChild) = 0;

    virtual XalanNode*
    removeChild(XalanNode*  oldChild) = 0;

    virtual XalanNode*
    appendChild(XalanNode*  newChild) = 0;



    virtual bool
    hasChildNodes() const = 0;





    virtual void
    setNodeValue(const XalanDOMString&      nodeValue) = 0;



    virtual void
    normalize() = 0;

    virtual bool
    isSupported(
            const XalanDOMString&   feature,
            const XalanDOMString&   version) const = 0;

    virtual const XalanDOMString&
    getNamespaceURI() const = 0;

    virtual const XalanDOMString&
    getPrefix() const = 0;

    virtual const XalanDOMString&
    getLocalName() const = 0;

    virtual void
    setPrefix(const XalanDOMString& prefix) = 0;

    virtual bool
    isIndexed() const = 0;

    virtual IndexType
    getIndex() const = 0;


    // These interfaces are new to XalanDocument...

    virtual XalanElement*
    createElement(const XalanDOMString& tagName) = 0;

    virtual XalanDocumentFragment*
    createDocumentFragment() = 0;

    virtual XalanText*
    createTextNode(const XalanDOMString&    data) = 0;

    virtual XalanComment*
    createComment(const XalanDOMString& data) = 0;

    virtual XalanCDATASection*
    createCDATASection(const XalanDOMString&    data) = 0;

    virtual XalanProcessingInstruction*
    createProcessingInstruction(
            const XalanDOMString&   target,
            const XalanDOMString&   data) = 0;

    virtual XalanAttr*
    createAttribute(const XalanDOMString&   name) = 0;

    virtual XalanEntityReference*
    createEntityReference(const XalanDOMString &name) = 0;



    virtual XalanDocumentType*
    getDoctype() const = 0;


    virtual XalanDOMImplementation*
    getImplementation() const = 0;


    virtual XalanElement*
    getDocumentElement() const = 0;

    virtual XalanNodeList*
    getElementsByTagName(const XalanDOMString&      tagname) const = 0;



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

    virtual XalanElement*
    createElementNS(
            const XalanDOMString&   namespaceURI,
            const XalanDOMString&   qualifiedName) = 0;

    virtual XalanAttr*
    createAttributeNS(
            const XalanDOMString& namespaceURI,
            const XalanDOMString& qualifiedName) = 0;

    virtual XalanNodeList*
    getElementsByTagNameNS(
            const XalanDOMString&   namespaceURI,
            const XalanDOMString&   localName) const = 0;

    virtual XalanElement*
    getElementById(const XalanDOMString&    elementId) const = 0;


protected:

    XalanDocument(const XalanDocument&  theSource);

    XalanDocument&
    operator=(const XalanDocument&  theSource);

    bool
    operator==(const XalanDocument&     theRHS) const;

private:
};



XALAN_CPP_NAMESPACE_END



#endif  // !defined(XALANDOCUMENT_HEADER_GUARD_1357924680)

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.10 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.