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  

ResultTreeFrag.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(RESULTTREEFRAG_HEADER_GUARD_1357924680)
00058 #define RESULTTREEFRAG_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XSLT/XSLTDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanNodeList.hpp>
00068 
00069 
00070 
00071 #include <XPath/ResultTreeFragBase.hpp>
00072 
00073 
00074 
00075 class XalanSourceTreeDocumentFragment;
00076 
00077 
00078 
00082 class XALAN_XSLT_EXPORT ResultTreeFrag : public ResultTreeFragBase, private XalanNodeList
00083 {
00084 public:
00085 
00089     explicit
00090     ResultTreeFrag(XalanSourceTreeDocumentFragment* theDocumentFragment = 0);
00091 
00098     ResultTreeFrag(
00099             const ResultTreeFrag&   theSource,
00100             bool                    deepClone = false);
00101 
00102     virtual
00103     ~ResultTreeFrag();
00104 
00105 
00106     // These interfaces are new...
00107 
00108     void
00109     clear();
00110 
00111 
00112     // These interfaces are inherited from ResultTreeFragBase...
00113 
00114     virtual XalanNode*
00115     getNodesetRoot() const;
00116 
00117 
00118     // These interfaces are inherited from XalanDocumentFragment...
00119 
00120     virtual const XalanDOMString&
00121     getNodeName() const;
00122 
00123     virtual const XalanDOMString&
00124     getNodeValue() const;
00125 
00126     virtual NodeType
00127     getNodeType() const;
00128 
00129     virtual XalanNode*
00130     getParentNode() const;
00131 
00132     virtual const XalanNodeList*
00133     getChildNodes() const;
00134 
00135     virtual XalanNode*
00136     getFirstChild() const;
00137 
00138     virtual XalanNode*
00139     getLastChild() const;
00140 
00141     virtual XalanNode*
00142     getPreviousSibling() const;
00143 
00144     virtual XalanNode*
00145     getNextSibling() const;
00146 
00147     virtual const XalanNamedNodeMap*
00148     getAttributes() const;
00149 
00150     virtual XalanDocument*
00151     getOwnerDocument() const;
00152 
00153 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00154     virtual XalanNode*
00155 #else
00156     virtual ResultTreeFrag*
00157 #endif
00158     cloneNode(bool deep) const;
00159 
00160     virtual XalanNode*
00161     insertBefore(
00162             XalanNode*  newChild,
00163             XalanNode*  refChild);
00164 
00165     virtual XalanNode*
00166     replaceChild(
00167             XalanNode*  newChild,
00168             XalanNode*  oldChild);
00169 
00170     virtual XalanNode*
00171     removeChild(XalanNode*  oldChild);
00172 
00173     virtual XalanNode*
00174     appendChild(XalanNode*  newChild);
00175 
00176     virtual bool
00177     hasChildNodes() const;
00178 
00179     virtual void
00180     setNodeValue(const XalanDOMString&  nodeValue);
00181 
00182     virtual void
00183     normalize();
00184 
00185     virtual bool
00186     isSupported(
00187             const XalanDOMString&   feature,
00188             const XalanDOMString&   version) const;
00189 
00190     virtual const XalanDOMString&
00191     getNamespaceURI() const;
00192 
00193     virtual const XalanDOMString&
00194     getPrefix() const;
00195 
00196     virtual const XalanDOMString&
00197     getLocalName() const;
00198 
00199     virtual void
00200     setPrefix(const XalanDOMString&     prefix);
00201 
00202     virtual bool
00203     isIndexed() const;
00204 
00205     virtual unsigned long
00206     getIndex() const;
00207 
00208 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00209     virtual ResultTreeFragBase*
00210 #else
00211     virtual ResultTreeFrag*
00212 #endif
00213     clone(bool  deep) const;
00214 
00215     XalanSourceTreeDocumentFragment*
00216     getDocumentFragment() const
00217     {
00218         return m_documentFragment;
00219     }
00220 
00221     void
00222     setDocumentFragment(XalanSourceTreeDocumentFragment*    theDocumentFragment)
00223     {
00224         m_documentFragment = theDocumentFragment;
00225     }
00226 
00227 private:
00228 
00229     // These methods are inherited from XalanNodeList...
00230 
00231     virtual XalanNode*
00232     item(unsigned int   index) const;
00233 
00234     virtual unsigned int
00235     getLength() const;
00236 
00237 
00238     // Not defined
00239     ResultTreeFrag&
00240     operator=(const ResultTreeFrag&     theRHS);
00241 
00242     bool
00243     operator==(const ResultTreeFrag&    theRHS) const;
00244 
00245     // Data members...
00246     XalanSourceTreeDocumentFragment*    m_documentFragment;
00247 
00248     static const XalanDOMString     s_emptyString;
00249 };
00250 
00251 
00252 
00253 #endif  // RESULTTREEFRAG_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.