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  

XalanSourceTreeComment.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(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <xalanc/XalanDOM/XalanComment.hpp>
00067 
00068 
00069 
00070 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 XALAN_CPP_NAMESPACE_BEGIN
00075 
00076 
00077 
00078 class XalanSourceTreeDocument;
00079 class XalanSourceTreeDocumentFragment;
00080 class XalanSourceTreeElement;
00081 class XalanSourceTreeProcessingInstruction;
00082 class XalanSourceTreeText;
00083 
00084 
00085 
00086 /*
00087  * <meta name="usage" content="experimental"/>
00088  *
00089  * Base class for the Xalan source tree Attr interface.
00090  *
00091  * This class is experimental and subject to change!!
00092  */
00093 
00094 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeComment : public XalanComment
00095 {
00096 public:
00097 
00101     static void
00102     initialize();
00103 
00107     static void
00108     terminate();
00109 
00110 
00121     XalanSourceTreeComment(
00122             const XalanDOMString&       theData,
00123             XalanSourceTreeDocument*    theOwnerDocument,
00124             XalanNode*                  theParentNode = 0,
00125             XalanNode*                  thePreviousSibling = 0,
00126             XalanNode*                  theNextSibling = 0,
00127             IndexType                   theIndex = 0);
00128 
00129     virtual
00130     ~XalanSourceTreeComment();
00131 
00132 
00136     virtual const XalanDOMString&
00137     getNodeName() const;
00138 
00142     virtual const XalanDOMString&
00143     getNodeValue() const;
00144 
00148     virtual NodeType
00149     getNodeType() const;
00150 
00160     virtual XalanNode*
00161     getParentNode() const;
00162 
00176     virtual const XalanNodeList*
00177     getChildNodes() const;
00178 
00184     virtual XalanNode*
00185     getFirstChild() const;
00186 
00192     virtual XalanNode*
00193     getLastChild() const;
00194 
00200     virtual XalanNode*
00201     getPreviousSibling() const;
00202 
00208     virtual XalanNode*
00209     getNextSibling() const;
00210 
00215     virtual const XalanNamedNodeMap*
00216     getAttributes() const;
00217 
00227     virtual XalanDocument*
00228     getOwnerDocument() const;
00229 
00231 
00233 
00252 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00253     virtual XalanNode*
00254 #else
00255     virtual XalanSourceTreeComment*
00256 #endif
00257     cloneNode(bool deep) const;
00258 
00260 
00262 
00279     virtual XalanNode*
00280     insertBefore(
00281             XalanNode*  newChild,
00282             XalanNode*  refChild);
00283 
00297     virtual XalanNode*
00298     replaceChild(
00299             XalanNode*  newChild,
00300             XalanNode*  oldChild);
00301 
00309     virtual XalanNode*
00310     removeChild(XalanNode*  oldChild);
00311 
00323     virtual XalanNode*
00324     appendChild(XalanNode*  newChild);
00325 
00327 
00329 
00337     virtual bool
00338     hasChildNodes() const;
00339 
00340 
00342 
00344 
00358     virtual void
00359     setNodeValue(const XalanDOMString&      nodeValue);
00360 
00362 
00364 
00381     virtual void
00382     normalize();
00383 
00397     virtual bool
00398     isSupported(
00399             const XalanDOMString&   feature,
00400             const XalanDOMString&   version) const;
00401 
00415     virtual const XalanDOMString&
00416     getNamespaceURI() const;
00417 
00422     virtual const XalanDOMString&
00423     getPrefix() const;
00424 
00432     virtual const XalanDOMString&
00433     getLocalName() const;
00434 
00464     virtual void
00465     setPrefix(const XalanDOMString& prefix);
00466 
00467     virtual bool
00468     isIndexed() const;
00469 
00470     virtual IndexType
00471     getIndex() const;
00472 
00474 
00475     // These interfaces are inherited from XalanCDATASection...
00476 
00479 
00495     virtual const XalanDOMString&
00496     getData() const;
00497 
00505     virtual unsigned int
00506     getLength() const;
00507 
00523     virtual XalanDOMString
00524     substringData(
00525             unsigned int    offset, 
00526             unsigned int    count) const;
00527 
00529 
00531 
00540     virtual void
00541     appendData(const XalanDOMString&    arg);
00542 
00553     virtual void
00554     insertData(
00555             unsigned int            offset,
00556             const  XalanDOMString&  arg);
00557 
00574     virtual void
00575     deleteData(
00576             unsigned int    offset, 
00577             unsigned int    count);
00578 
00597     virtual void
00598     replaceData(
00599             unsigned int            offset, 
00600             unsigned int            count, 
00601             const XalanDOMString&   arg);
00602 
00604 
00605 
00606     // public interfaces not inherited from XalanComment...
00607 
00608     void
00609     setParent(XalanSourceTreeElement*   theParent);
00610 
00611     void
00612     setParent(XalanSourceTreeDocumentFragment*  theParent);
00613 
00614     void
00615     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00616 
00617     void
00618     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00619 
00620     void
00621     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00622 
00623     void
00624     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00625 
00626     void
00627     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00628 
00629     void
00630     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00631 
00632     void
00633     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00634 
00635     void
00636     appendSiblingNode(XalanSourceTreeText*  theSibling);
00637 
00638     void
00639     setIndex(IndexType  theIndex)
00640     {
00641         m_index = theIndex;
00642     }
00643 
00644 protected:
00645 
00646     XalanSourceTreeComment(
00647             const XalanSourceTreeComment&   theSource,
00648             bool                            deep = false);
00649 
00650 private:
00651 
00652     // Not implemented...
00653     XalanSourceTreeComment&
00654 	operator=(const XalanSourceTreeComment&    theSource);
00655 
00656     bool
00657 	operator==(const XalanSourceTreeComment&   theRHS) const;
00658 
00659 
00660     // Data members...
00661     const XalanDOMString&           m_data;
00662 
00663     XalanSourceTreeDocument*        m_ownerDocument;
00664 
00665     XalanNode*                      m_parentNode;
00666 
00667     XalanNode*                      m_previousSibling;
00668 
00669     XalanNode*                      m_nextSibling;
00670 
00671     IndexType                       m_index;
00672 
00673     static const XalanDOMString&    s_nameString;
00674 };
00675 
00676 
00677 
00678 XALAN_CPP_NAMESPACE_END
00679 
00680 
00681 
00682 #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.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.