Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XalanSourceTreeComment.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <XalanDOM/XalanComment.hpp>
00067 
00068 
00069 
00070 #include <XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 class XalanSourceTreeDocument;
00075 class XalanSourceTreeElement;
00076 class XalanSourceTreeProcessingInstruction;
00077 class XalanSourceTreeText;
00078 
00079 
00080 
00081 /*
00082  * <meta name="usage" content="experimental"/>
00083  *
00084  * Base class for the Xalan source tree Attr interface.
00085  *
00086  * This class is experimental and subject to change!!
00087  */
00088 
00089 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeComment : public XalanComment
00090 {
00091 public:
00092 
00103     XalanSourceTreeComment(
00104             const XalanDOMString&       theData,
00105             XalanSourceTreeDocument*    theOwnerDocument,
00106             XalanSourceTreeElement*     theParentElement = 0,
00107             XalanNode*                  thePreviousSibling = 0,
00108             XalanNode*                  theNextSibling = 0,
00109             unsigned int                theIndex = 0);
00110 
00111     virtual
00112     ~XalanSourceTreeComment();
00113 
00114 
00118     virtual const XalanDOMString&
00119     getNodeName() const;
00120 
00124     virtual const XalanDOMString&
00125     getNodeValue() const;
00126 
00130     virtual NodeType
00131     getNodeType() const;
00132 
00142     virtual XalanNode*
00143     getParentNode() const;
00144 
00158     virtual const XalanNodeList*
00159     getChildNodes() const;
00160 
00166     virtual XalanNode*
00167     getFirstChild() const;
00168 
00174     virtual XalanNode*
00175     getLastChild() const;
00176 
00182     virtual XalanNode*
00183     getPreviousSibling() const;
00184 
00190     virtual XalanNode*
00191     getNextSibling() const;
00192 
00197     virtual const XalanNamedNodeMap*
00198     getAttributes() const;
00199 
00209     virtual XalanDocument*
00210     getOwnerDocument() const;
00211 
00213 
00215 
00234 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00235     virtual XalanNode*
00236 #else
00237     virtual XalanSourceTreeComment*
00238 #endif
00239     cloneNode(bool deep) const;
00240 
00242 
00244 
00261     virtual XalanNode*
00262     insertBefore(
00263             XalanNode*  newChild,
00264             XalanNode*  refChild);
00265 
00279     virtual XalanNode*
00280     replaceChild(
00281             XalanNode*  newChild,
00282             XalanNode*  oldChild);
00283 
00291     virtual XalanNode*
00292     removeChild(XalanNode*  oldChild);
00293 
00305     virtual XalanNode*
00306     appendChild(XalanNode*  newChild);
00307 
00309 
00311 
00319     virtual bool
00320     hasChildNodes() const;
00321 
00322 
00324 
00326 
00340     virtual void
00341     setNodeValue(const XalanDOMString&      nodeValue);
00342 
00344 
00346 
00363     virtual void
00364     normalize();
00365 
00379     virtual bool
00380     supports(
00381             const XalanDOMString&   feature,
00382             const XalanDOMString&   version) const;
00383 
00397     virtual const XalanDOMString&
00398     getNamespaceURI() const;
00399 
00404     virtual const XalanDOMString&
00405     getPrefix() const;
00406 
00414     virtual const XalanDOMString&
00415     getLocalName() const;
00416 
00446     virtual void
00447     setPrefix(const XalanDOMString& prefix);
00448 
00449     virtual bool
00450     isIndexed() const;
00451 
00452     virtual unsigned long
00453     getIndex() const;
00454 
00456 
00457     // These interfaces are inherited from XalanCDATASection...
00458 
00461 
00477     virtual const XalanDOMString&
00478     getData() const;
00479 
00487     virtual unsigned int
00488     getLength() const;
00489 
00505     virtual XalanDOMString
00506     substringData(
00507             unsigned int    offset, 
00508             unsigned int    count) const;
00509 
00511 
00513 
00522     virtual void
00523     appendData(const XalanDOMString&    arg);
00524 
00535     virtual void
00536     insertData(
00537             unsigned int            offset,
00538             const  XalanDOMString&  arg);
00539 
00556     virtual void
00557     deleteData(
00558             unsigned int    offset, 
00559             unsigned int    count);
00560 
00579     virtual void
00580     replaceData(
00581             unsigned int            offset, 
00582             unsigned int            count, 
00583             const XalanDOMString&   arg);
00584 
00586 
00587 
00588     // public interfaces not inherited from XalanComment...
00589 
00590     XalanSourceTreeElement*
00591     getParentElement() const
00592     {
00593         return m_parentElement;
00594     }
00595 
00596     void
00597     setParentElement(XalanSourceTreeElement*    theParentElement)
00598     {
00599         m_parentElement = theParentElement;
00600     }
00601 
00602     void
00603     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00604 
00605     void
00606     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00607 
00608     void
00609     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00610 
00611     void
00612     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00613 
00614     void
00615     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00616 
00617     void
00618     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00619 
00620     void
00621     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00622 
00623     void
00624     appendSiblingNode(XalanSourceTreeText*  theSibling);
00625 
00626     void
00627     setIndex(unsigned int   theIndex)
00628     {
00629         m_index = theIndex;
00630     }
00631 
00632 protected:
00633 
00634     XalanSourceTreeComment(
00635             const XalanSourceTreeComment&   theSource,
00636             bool                            deep = false);
00637 
00638 private:
00639 
00640     // Not implemented...
00641     XalanSourceTreeComment&
00642     operator=(const XalanSourceTreeComment& theSource);
00643 
00644     bool
00645     operator==(const XalanSourceTreeComment&    theRHS) const;
00646 
00647 
00648     // Data members...
00649     const XalanDOMString&       m_data;
00650 
00651     XalanSourceTreeDocument*    m_ownerDocument;
00652 
00653     XalanSourceTreeElement*     m_parentElement;
00654 
00655     XalanNode*                  m_previousSibling;
00656 
00657     XalanNode*                  m_nextSibling;
00658 
00659     unsigned int                m_index;
00660 };
00661 
00662 
00663 
00664 #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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.