Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

             

---

XalanSourceTreeComment.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(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
#define XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680



#include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>



#include <xalanc/XalanDOM/XalanComment.hpp>



#include <xalanc/XalanDOM/XalanDOMString.hpp>



XALAN_CPP_NAMESPACE_BEGIN



class XalanSourceTreeDocument;
class XalanSourceTreeDocumentFragment;
class XalanSourceTreeElement;
class XalanSourceTreeProcessingInstruction;
class XalanSourceTreeText;



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

class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeComment : public XalanComment
{
public:

    static void
    initialize(MemoryManagerType& theManager);

    static void
    terminate();


    XalanSourceTreeComment(
            const XalanDOMString&       theData,
            XalanSourceTreeDocument*    theOwnerDocument,
            XalanNode*                  theParentNode = 0,
            XalanNode*                  thePreviousSibling = 0,
            XalanNode*                  theNextSibling = 0,
            IndexType                   theIndex = 0);

    virtual
    ~XalanSourceTreeComment();


    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;

    virtual XalanDocument*
    getOwnerDocument() const;



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



    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;

    virtual const XalanDOMString&
    getPrefix() const;

    virtual const XalanDOMString&
    getLocalName() const;

    virtual void
    setPrefix(const XalanDOMString& prefix);

    virtual bool
    isIndexed() const;

    virtual IndexType
    getIndex() const;


    // These interfaces are inherited from XalanCDATASection...


    virtual const XalanDOMString&
    getData() const;

    virtual unsigned int
    getLength() const;

    virtual XalanDOMString&
    substringData(
            unsigned int    offset, 
            unsigned int    count,
            XalanDOMString& theBuffer) const;



    virtual void
    appendData(const XalanDOMString&    arg);

    virtual void
    insertData(
            unsigned int            offset,
            const  XalanDOMString&  arg);

    virtual void
    deleteData(
            unsigned int    offset, 
            unsigned int    count);

    virtual void
    replaceData(
            unsigned int            offset, 
            unsigned int            count, 
            const XalanDOMString&   arg);



    // public interfaces not inherited from XalanComment...

    void
    setParent(XalanSourceTreeElement*   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
    setIndex(IndexType  theIndex)
    {
        m_index = theIndex;
    }

protected:

    XalanSourceTreeComment(
            const XalanSourceTreeComment&   theSource,
            bool                            deep = false);

private:

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

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


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

    XalanSourceTreeDocument*        m_ownerDocument;

    XalanNode*                      m_parentNode;

    XalanNode*                      m_previousSibling;

    XalanNode*                      m_nextSibling;

    IndexType                       m_index;

    static const XalanDOMString&    s_nameString;
};



XALAN_CPP_NAMESPACE_END



#endif  // !defined(XALANSOURCETREECOMMENT_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.