Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

Main Page   Namespace List   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 XalanSourceTreeDocumentFragment;
00076 class XalanSourceTreeElement;
00077 class XalanSourceTreeProcessingInstruction;
00078 class XalanSourceTreeText;
00079 
00080 
00081 
00082 /*
00083  * <meta name="usage" content="experimental"/>
00084  *
00085  * Base class for the Xalan source tree Attr interface.
00086  *
00087  * This class is experimental and subject to change!!
00088  */
00089 
00090 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeComment : public XalanComment
00091 {
00092 public:
00093 
00097     static void
00098     initialize();
00099 
00103     static void
00104     terminate();
00105 
00106 
00117     XalanSourceTreeComment(
00118             const XalanDOMString&       theData,
00119             XalanSourceTreeDocument*    theOwnerDocument,
00120             XalanNode*                  theParentNode = 0,
00121             XalanNode*                  thePreviousSibling = 0,
00122             XalanNode*                  theNextSibling = 0,
00123             unsigned int                theIndex = 0);
00124 
00125     virtual
00126     ~XalanSourceTreeComment();
00127 
00128 
00132     virtual const XalanDOMString&
00133     getNodeName() const;
00134 
00138     virtual const XalanDOMString&
00139     getNodeValue() const;
00140 
00144     virtual NodeType
00145     getNodeType() const;
00146 
00156     virtual XalanNode*
00157     getParentNode() const;
00158 
00172     virtual const XalanNodeList*
00173     getChildNodes() const;
00174 
00180     virtual XalanNode*
00181     getFirstChild() const;
00182 
00188     virtual XalanNode*
00189     getLastChild() const;
00190 
00196     virtual XalanNode*
00197     getPreviousSibling() const;
00198 
00204     virtual XalanNode*
00205     getNextSibling() const;
00206 
00211     virtual const XalanNamedNodeMap*
00212     getAttributes() const;
00213 
00223     virtual XalanDocument*
00224     getOwnerDocument() const;
00225 
00226     //@}
00228     //@{
00229 
00248 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00249     virtual XalanNode*
00250 #else
00251     virtual XalanSourceTreeComment*
00252 #endif
00253     cloneNode(bool deep) const;
00254 
00255     //@}
00257     //@{
00258 
00275     virtual XalanNode*
00276     insertBefore(
00277             XalanNode*  newChild,
00278             XalanNode*  refChild);
00279 
00293     virtual XalanNode*
00294     replaceChild(
00295             XalanNode*  newChild,
00296             XalanNode*  oldChild);
00297 
00305     virtual XalanNode*
00306     removeChild(XalanNode*  oldChild);
00307 
00319     virtual XalanNode*
00320     appendChild(XalanNode*  newChild);
00321 
00322     //@}
00324     //@{
00325 
00333     virtual bool
00334     hasChildNodes() const;
00335 
00336 
00337     //@}
00339     //@{
00340 
00354     virtual void
00355     setNodeValue(const XalanDOMString&      nodeValue);
00356 
00357     //@}
00359     //@{
00360 
00377     virtual void
00378     normalize();
00379 
00393     virtual bool
00394     isSupported(
00395             const XalanDOMString&   feature,
00396             const XalanDOMString&   version) const;
00397 
00411     virtual const XalanDOMString&
00412     getNamespaceURI() const;
00413 
00418     virtual const XalanDOMString&
00419     getPrefix() const;
00420 
00428     virtual const XalanDOMString&
00429     getLocalName() const;
00430 
00460     virtual void
00461     setPrefix(const XalanDOMString& prefix);
00462 
00463     virtual bool
00464     isIndexed() const;
00465 
00466     virtual unsigned long
00467     getIndex() const;
00468 
00469     //@}
00470 
00471     // These interfaces are inherited from XalanCDATASection...
00472 
00474     //@{
00491     virtual const XalanDOMString&
00492     getData() const;
00493 
00501     virtual unsigned int
00502     getLength() const;
00503 
00519     virtual XalanDOMString
00520     substringData(
00521             unsigned int    offset, 
00522             unsigned int    count) const;
00523 
00524     //@}
00526     //@{
00536     virtual void
00537     appendData(const XalanDOMString&    arg);
00538 
00549     virtual void
00550     insertData(
00551             unsigned int            offset,
00552             const  XalanDOMString&  arg);
00553 
00570     virtual void
00571     deleteData(
00572             unsigned int    offset, 
00573             unsigned int    count);
00574 
00593     virtual void
00594     replaceData(
00595             unsigned int            offset, 
00596             unsigned int            count, 
00597             const XalanDOMString&   arg);
00598 
00599   //@}
00600 
00601 
00602     // public interfaces not inherited from XalanComment...
00603 
00604     void
00605     setParent(XalanSourceTreeElement*   theParent);
00606 
00607     void
00608     setParent(XalanSourceTreeDocumentFragment*  theParent);
00609 
00610     void
00611     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00612 
00613     void
00614     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00615 
00616     void
00617     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00618 
00619     void
00620     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00621 
00622     void
00623     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00624 
00625     void
00626     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00627 
00628     void
00629     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00630 
00631     void
00632     appendSiblingNode(XalanSourceTreeText*  theSibling);
00633 
00634     void
00635     setIndex(unsigned int   theIndex)
00636     {
00637         m_index = theIndex;
00638     }
00639 
00640 protected:
00641 
00642     XalanSourceTreeComment(
00643             const XalanSourceTreeComment&   theSource,
00644             bool                            deep = false);
00645 
00646 private:
00647 
00648     // Not implemented...
00649     XalanSourceTreeComment&
00650     operator=(const XalanSourceTreeComment& theSource);
00651 
00652     bool
00653     operator==(const XalanSourceTreeComment&    theRHS) const;
00654 
00655 
00656     // Data members...
00657     const XalanDOMString&           m_data;
00658 
00659     XalanSourceTreeDocument*        m_ownerDocument;
00660 
00661     XalanNode*                      m_parentNode;
00662 
00663     XalanNode*                      m_previousSibling;
00664 
00665     XalanNode*                      m_nextSibling;
00666 
00667     unsigned int                    m_index;
00668 
00669     static const XalanDOMString&    s_nameString;
00670 };
00671 
00672 
00673 
00674 #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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.