## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.7

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

# XalanSourceTreeText.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  *
    00005  * Copyright (c) 1999-2004 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(XALANSOURCETREETEXT_HEADER_GUARD_1357924680)
    00058 #define XALANSOURCETREETEXT_HEADER_GUARD_1357924680
    00059
    00060
    00061
    00062 #include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
    00063
    00064
    00065
    00066 #include <xalanc/XalanDOM/XalanText.hpp>
    00067
    00068
    00069
    00070 #include <xalanc/XalanDOM/XalanDOMString.hpp>
    00071
    00072
    00073
    00074 XALAN_CPP_NAMESPACE_BEGIN
    00075
    00076
    00077
    00078 class XalanSourceTreeComment;
    00079 class XalanSourceTreeDocumentFragment;
    00080 class XalanSourceTreeElement;
    00081 class XalanSourceTreeProcessingInstruction;
    00082
    00083
    00084
    00085 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeText : public XalanText
    00086 {
    00087 public:
    00088
    00092     static void
    00093     initialize();
    00094
    00098     static void
    00099     terminate();
    00100
    00111     XalanSourceTreeText(
    00112             const XalanDOMString&   theData,
    00113             XalanNode*              theParentNode = 0,
    00114             XalanNode*              thePreviousSibling = 0,
    00115             XalanNode*              theNextSibling = 0,
    00116             IndexType               theIndex = 0);
    00117
    00118     virtual
    00119     ~XalanSourceTreeText();
    00120
    00121
    00125     virtual const XalanDOMString&
    00126     getNodeName() const;
    00127
    00131     virtual const XalanDOMString&
    00132     getNodeValue() const;
    00133
    00137     virtual NodeType
    00138     getNodeType() const;
    00139
    00149     virtual XalanNode*
    00150     getParentNode() const;
    00151
    00165     virtual const XalanNodeList*
    00166     getChildNodes() const;
    00167
    00173     virtual XalanNode*
    00174     getFirstChild() const;
    00175
    00181     virtual XalanNode*
    00182     getLastChild() const;
    00183
    00189     virtual XalanNode*
    00190     getPreviousSibling() const;
    00191
    00197     virtual XalanNode*
    00198     getNextSibling() const;
    00199
    00204     virtual const XalanNamedNodeMap*
    00205     getAttributes() const;
    00206
    00216     virtual XalanDocument*
    00217     getOwnerDocument() const;
    00218
    00220
    00222
    00241 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
    00242     virtual XalanNode*
    00243 #else
    00244     virtual XalanSourceTreeText*
    00245 #endif
    00246     cloneNode(bool deep) const;
    00247
    00249
    00251
    00268     virtual XalanNode*
    00269     insertBefore(
    00270             XalanNode*  newChild,
    00271             XalanNode*  refChild);
    00272
    00286     virtual XalanNode*
    00287     replaceChild(
    00288             XalanNode*  newChild,
    00289             XalanNode*  oldChild);
    00290
    00298     virtual XalanNode*
    00299     removeChild(XalanNode*  oldChild);
    00300
    00312     virtual XalanNode*
    00313     appendChild(XalanNode*  newChild);
    00314
    00316
    00318
    00326     virtual bool
    00327     hasChildNodes() const;
    00328
    00329
    00331
    00333
    00334
    00348     virtual void
    00349     setNodeValue(const XalanDOMString&      nodeValue);
    00350
    00352
    00354
    00371     virtual void
    00372     normalize();
    00373
    00387     virtual bool
    00388     isSupported(
    00389             const XalanDOMString&   feature,
    00390             const XalanDOMString&   version) const;
    00391
    00405     virtual const XalanDOMString&
    00406     getNamespaceURI() const;
    00407
    00412     virtual const XalanDOMString&
    00413     getPrefix() const;
    00414
    00422     virtual const XalanDOMString&
    00423     getLocalName() const;
    00424
    00454     virtual void
    00455     setPrefix(const XalanDOMString&     prefix);
    00456
    00457     virtual bool
    00458     isIndexed() const;
    00459
    00460     virtual IndexType
    00461     getIndex() const;
    00462
    00464
    00465     // These interfaces are inherited from XalanCDATASection...
    00466
    00469
    00485     virtual const XalanDOMString&
    00486     getData() const;
    00487
    00495     virtual unsigned int
    00496     getLength() const;
    00497
    00513     virtual XalanDOMString
    00514     substringData(
    00515             unsigned int    offset,
    00516             unsigned int    count) const;
    00517
    00519
    00521
    00530     virtual void
    00531     appendData(const XalanDOMString&    arg);
    00532
    00543     virtual void
    00544     insertData(
    00545             unsigned int            offset,
    00546             const  XalanDOMString&  arg);
    00547
    00564     virtual void
    00565     deleteData(
    00566             unsigned int    offset,
    00567             unsigned int    count);
    00568
    00587     virtual void
    00588     replaceData(
    00589             unsigned int            offset,
    00590             unsigned int            count,
    00591             const XalanDOMString&   arg);
    00592
    00594
    00596
    00598
    00616     virtual XalanText*
    00617     splitText(unsigned int  offset);
    00618
    00620
    00621     virtual bool
    00622     isIgnorableWhitespace() const;
    00623
    00624
    00625     // public interfaces not inherited from XalanCDATASection...
    00626
    00627     void
    00628     setParent(XalanSourceTreeElement*   theParent);
    00629
    00630     void
    00631     setParent(XalanSourceTreeDocumentFragment*  theParent);
    00632
    00633     void
    00634     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
    00635
    00636     void
    00637     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
    00638
    00639     void
    00640     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
    00641
    00642     void
    00643     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
    00644
    00645     void
    00646     appendSiblingNode(XalanSourceTreeComment*   theSibling);
    00647
    00648     void
    00649     appendSiblingNode(XalanSourceTreeElement*   theSibling);
    00650
    00651     void
    00652     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
    00653
    00654     void
    00655     appendSiblingNode(XalanSourceTreeText*  theSibling);
    00656
    00657     void
    00658     setIndex(IndexType  theIndex)
    00659     {
    00660         m_index = theIndex;
    00661     }
    00662
    00663 protected:
    00664
    00665     XalanSourceTreeText(
    00666             const XalanSourceTreeText&  theSource,
    00667             bool                        /* deep */);
    00668
    00669 private:
    00670
    00671     // Not implemented...
    00672     XalanSourceTreeText&
    00673 	operator=(const XalanSourceTreeText&   theSource);
    00674
    00675     bool
    00676 	operator==(const XalanSourceTreeText&  theRHS) const;
    00677
    00678
    00679     // Data members...
    00680     const XalanDOMString&           m_data;
    00681
    00682     XalanNode*                      m_parentNode;
    00683
    00684     XalanNode*                      m_previousSibling;
    00685
    00686     XalanNode*                      m_nextSibling;
    00687
    00688     IndexType                       m_index;
    00689
    00690     static const XalanDOMString&    s_nameString;
    00691 };
    00692
    00693
    00694
    00695 XALAN_CPP_NAMESPACE_END
    00696
    00697
    00698
    00699 #endif  // !defined(XALANSOURCETREETEXT_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.7 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.