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  

XalanSourceTreeText.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 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 <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <XalanDOM/XalanText.hpp>
00067 
00068 
00069 
00070 #include <XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 class XalanSourceTreeComment;
00075 class XalanSourceTreeElement;
00076 class XalanSourceTreeProcessingInstruction;
00077 
00078 
00079 
00080 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeText : public XalanText
00081 {
00082 public:
00083 
00087     static void
00088     initialize();
00089 
00093     static void
00094     terminate();
00095 
00106     XalanSourceTreeText(
00107             const XalanDOMString&       theData,
00108             XalanSourceTreeElement*     theParentElement = 0,
00109             XalanNode*                  thePreviousSibling = 0,
00110             XalanNode*                  theNextSibling = 0,
00111             unsigned int                theIndex = 0);
00112 
00113     virtual
00114     ~XalanSourceTreeText();
00115 
00116 
00120     virtual const XalanDOMString&
00121     getNodeName() const;
00122 
00126     virtual const XalanDOMString&
00127     getNodeValue() const;
00128 
00132     virtual NodeType
00133     getNodeType() const;
00134 
00144     virtual XalanNode*
00145     getParentNode() const;
00146 
00160     virtual const XalanNodeList*
00161     getChildNodes() const;
00162 
00168     virtual XalanNode*
00169     getFirstChild() const;
00170 
00176     virtual XalanNode*
00177     getLastChild() const;
00178 
00184     virtual XalanNode*
00185     getPreviousSibling() const;
00186 
00192     virtual XalanNode*
00193     getNextSibling() const;
00194 
00199     virtual const XalanNamedNodeMap*
00200     getAttributes() const;
00201 
00211     virtual XalanDocument*
00212     getOwnerDocument() const;
00213 
00215 
00217 
00236 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00237     virtual XalanNode*
00238 #else
00239     virtual XalanSourceTreeText*
00240 #endif
00241     cloneNode(bool deep) const;
00242 
00244 
00246 
00263     virtual XalanNode*
00264     insertBefore(
00265             XalanNode*  newChild,
00266             XalanNode*  refChild);
00267 
00281     virtual XalanNode*
00282     replaceChild(
00283             XalanNode*  newChild,
00284             XalanNode*  oldChild);
00285 
00293     virtual XalanNode*
00294     removeChild(XalanNode*  oldChild);
00295 
00307     virtual XalanNode*
00308     appendChild(XalanNode*  newChild);
00309 
00311 
00313 
00321     virtual bool
00322     hasChildNodes() const;
00323 
00324 
00326 
00328 
00329 
00343     virtual void
00344     setNodeValue(const XalanDOMString&      nodeValue);
00345 
00347 
00349 
00366     virtual void
00367     normalize();
00368 
00382     virtual bool
00383     supports(
00384             const XalanDOMString&   feature,
00385             const XalanDOMString&   version) const;
00386 
00400     virtual const XalanDOMString&
00401     getNamespaceURI() const;
00402 
00407     virtual const XalanDOMString&
00408     getPrefix() const;
00409 
00417     virtual const XalanDOMString&
00418     getLocalName() const;
00419 
00449     virtual void
00450     setPrefix(const XalanDOMString&     prefix);
00451 
00452     virtual bool
00453     isIndexed() const;
00454 
00455     virtual unsigned long
00456     getIndex() const;
00457 
00459 
00460     // These interfaces are inherited from XalanCDATASection...
00461 
00464 
00480     virtual const XalanDOMString&
00481     getData() const;
00482 
00490     virtual unsigned int
00491     getLength() const;
00492 
00508     virtual XalanDOMString
00509     substringData(
00510             unsigned int    offset, 
00511             unsigned int    count) const;
00512 
00514 
00516 
00525     virtual void
00526     appendData(const XalanDOMString&    arg);
00527 
00538     virtual void
00539     insertData(
00540             unsigned int            offset,
00541             const  XalanDOMString&  arg);
00542 
00559     virtual void
00560     deleteData(
00561             unsigned int    offset, 
00562             unsigned int    count);
00563 
00582     virtual void
00583     replaceData(
00584             unsigned int            offset, 
00585             unsigned int            count, 
00586             const XalanDOMString&   arg);
00587 
00589 
00591 
00593 
00611     virtual XalanText*
00612     splitText(unsigned int  offset);
00613 
00615 
00616     virtual bool
00617     isIgnorableWhitespace() const;
00618 
00619 
00620     // public interfaces not inherited from XalanCDATASection...
00621 
00622     XalanSourceTreeElement*
00623     getParentElement() const
00624     {
00625         return m_parentElement;
00626     }
00627 
00628     void
00629     setParentElement(XalanSourceTreeElement*    theParentElement)
00630     {
00631         m_parentElement = theParentElement;
00632     }
00633 
00634     void
00635     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00636 
00637     void
00638     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00639 
00640     void
00641     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00642 
00643     void
00644     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00645 
00646     void
00647     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00648 
00649     void
00650     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00651 
00652     void
00653     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00654 
00655     void
00656     appendSiblingNode(XalanSourceTreeText*  theSibling);
00657 
00658     void
00659     setIndex(unsigned int   theIndex)
00660     {
00661         m_index = theIndex;
00662     }
00663 
00664 protected:
00665 
00666     XalanSourceTreeText(
00667             const XalanSourceTreeText&  theSource,
00668             bool                        /* deep */);
00669 
00670 private:
00671 
00672     // Not implemented...
00673     XalanSourceTreeText&
00674     operator=(const XalanSourceTreeText&    theSource);
00675 
00676     bool
00677     operator==(const XalanSourceTreeText&   theRHS) const;
00678 
00679 
00680     // Data members...
00681     const XalanDOMString&           m_data;
00682 
00683     XalanSourceTreeElement*         m_parentElement;
00684 
00685     XalanNode*                      m_previousSibling;
00686 
00687     XalanNode*                      m_nextSibling;
00688 
00689     unsigned int                    m_index;
00690 
00691     static const XalanDOMString&    s_nameString;
00692 };
00693 
00694 
00695 
00696 #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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.