Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.9

XalanSourceTreeElement.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(XALANSOURCETREEELEMENT_HEADER_GUARD_1357924680)
#define XALANSOURCETREEELEMENT_HEADER_GUARD_1357924680



#include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>



#include <xalanc/XalanDOM/XalanDOMString.hpp>
#include <xalanc/XalanDOM/XalanElement.hpp>
#include <xalanc/XalanDOM/XalanNamedNodeMap.hpp>



XALAN_CPP_NAMESPACE_BEGIN



class XalanSourceTreeAttr;
class XalanSourceTreeComment;
class XalanSourceTreeDocument;
class XalanSourceTreeDocumentFragment;
class XalanSourceTreeProcessingInstruction;
class XalanSourceTreeText;



class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeElement : public XalanElement
{
public:

    XalanSourceTreeElement(
            MemoryManagerType&          theManager,
            const XalanDOMString&       theTagName,
            XalanSourceTreeDocument*    theOwnerDocument,
            XalanNode*                  theParentNode = 0,
            XalanNode*                  thePreviousSibling = 0,
            XalanNode*                  theNextSibling = 0,
            IndexType                   theIndex = 0);

    virtual
    ~XalanSourceTreeElement();

    MemoryManagerType& 
    getMemoryManager()
    {
        return m_memoryManager;
    }
    virtual const XalanDOMString&
    getNodeName() const;

    virtual const XalanDOMString&
    getNodeValue() const;

    virtual NodeType
    getNodeType() const;

    virtual XalanNode*
    getParentNode() const;

    virtual const XalanNodeList*
    getChildNodes() const;

    virtual XalanNode*
    getFirstChild() const;

    virtual XalanNode*
    getLastChild() const;

    virtual XalanNode*
    getPreviousSibling() const;

    virtual XalanNode*
    getNextSibling() const;

    virtual const XalanNamedNodeMap*
    getAttributes() const = 0;

    virtual XalanDocument*
    getOwnerDocument() const;



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



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

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

    virtual XalanNode*
    removeChild(XalanNode*  oldChild);

    virtual XalanNode*
    appendChild(XalanNode*  newChild);



    virtual bool
    hasChildNodes() const;





    virtual void
    setNodeValue(const XalanDOMString&      nodeValue);



    virtual void
    normalize();

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

    virtual const XalanDOMString&
    getNamespaceURI() const = 0;

    virtual const XalanDOMString&
    getPrefix() const = 0;

    virtual const XalanDOMString&
    getLocalName() const = 0;

    virtual void
    setPrefix(const XalanDOMString& prefix);

    virtual bool
    isIndexed() const;

    virtual IndexType
    getIndex() const;


    // These interfaces are inherited from XalanElement...

    virtual const XalanDOMString&
    getTagName() const;

    virtual const XalanDOMString&
    getAttribute(const XalanDOMString&      name) const = 0;

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

    virtual XalanNodeList*
    getElementsByTagName(const XalanDOMString&  name) const;



    virtual void
    setAttribute(
            const XalanDOMString&   name, 
            const XalanDOMString&   value);

    virtual XalanAttr*
    setAttributeNode(XalanAttr*     newAttr);


    
    virtual XalanAttr*
    removeAttributeNode(XalanAttr*  oldAttr);

    virtual void
    removeAttribute(const XalanDOMString&   name);



    virtual const XalanDOMString&
    getAttributeNS(
            const XalanDOMString&   namespaceURI,
            const XalanDOMString&   localName) const = 0;

    virtual void
    setAttributeNS(
            const XalanDOMString&   namespaceURI,
            const XalanDOMString&   qualifiedName,
            const XalanDOMString&   value);

    virtual void
    removeAttributeNS(
            const XalanDOMString&   namespaceURI,
            const XalanDOMString&   localName);

    virtual XalanAttr*
    getAttributeNodeNS(
            const XalanDOMString&   namespaceURI,
            const XalanDOMString&   localName) const = 0;

    virtual XalanAttr*
    setAttributeNodeNS(XalanAttr*   newAttr);

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



    // public interfaces not inherited from XalanElement...

    XalanSourceTreeDocument*
    getDocument() const
    {
        return m_ownerDocument;
    }

    void
    setParent(XalanSourceTreeElement*   theParent)
    {
        m_parentNode = theParent;
    }

    void
    setParent(XalanSourceTreeDocumentFragment*  theParent);

    void
    setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);

    void
    setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);

    void
    setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);

    void
    setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);

    void
    appendSiblingNode(XalanSourceTreeComment*   theSibling);

    void
    appendSiblingNode(XalanSourceTreeElement*   theSibling);

    void
    appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);

    void
    appendSiblingNode(XalanSourceTreeText*  theSibling);

    void
    appendChildNode(XalanSourceTreeComment*     theChild);

    void
    appendChildNode(XalanSourceTreeElement*     theChild);

    void
    appendChildNode(XalanSourceTreeProcessingInstruction*   theChild);

    void
    appendChildNode(XalanSourceTreeText*    theChild);

    void
    setIndex(IndexType  theIndex)
    {
        m_index = theIndex;
    }

    void
    clearChildren()
    {
        m_firstChild = 0;
    }

protected:

    XalanSourceTreeElement(
            MemoryManagerType&              theManager,
            const XalanSourceTreeElement&   theSource,
            bool                            deep = false);

    static const XalanDOMString     s_emptyString;

    // Data members...
    const XalanDOMString&       m_tagName;

private:

    // Not implemented...
    XalanSourceTreeElement&
    operator=(const XalanSourceTreeElement&     theSource);

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


    // Data members...
    MemoryManagerType&          m_memoryManager;

    XalanSourceTreeDocument*    m_ownerDocument;

    XalanNode*                  m_parentNode;

    XalanNode*                  m_previousSibling;

    XalanNode*                  m_nextSibling;

    XalanNode*                  m_firstChild;

    IndexType                   m_index;
};



XALAN_CPP_NAMESPACE_END



#endif  // !defined(XALANSOURCETREEELEMENT_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.9 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.