Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

ResultTreeFrag.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 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 <xalanc/XSLT/XSLTDefinitions.hpp>
00064 
00065 
00066 
00067 #include <xalanc/XalanDOM/XalanNodeList.hpp>
00068 
00069 
00070 
00071 #include <xalanc/XPath/ResultTreeFragBase.hpp>
00072 
00073 
00074 
00075 XALAN_CPP_NAMESPACE_BEGIN
00076 
00077 
00078 
00079 class XalanSourceTreeDocumentFragment;
00080 
00081 
00082 
00086 class XALAN_XSLT_EXPORT ResultTreeFrag : public ResultTreeFragBase, private XalanNodeList
00087 {
00088 public:
00089 
00093     explicit
00094     ResultTreeFrag(XalanSourceTreeDocumentFragment* theDocumentFragment = 0);
00095 
00102     ResultTreeFrag(
00103             const ResultTreeFrag&   theSource,
00104             bool                    deepClone = false);
00105 
00106     virtual
00107     ~ResultTreeFrag();
00108 
00109 
00110     // These interfaces are new...
00111 
00112     void
00113     clear();
00114 
00115 
00116     // These interfaces are inherited from ResultTreeFragBase...
00117 
00118     virtual XalanNode*
00119     getNodesetRoot() const;
00120 
00121 
00122     // These interfaces are inherited from XalanDocumentFragment...
00123 
00124     virtual const XalanDOMString&
00125     getNodeName() const;
00126 
00127     virtual const XalanDOMString&
00128     getNodeValue() const;
00129 
00130     virtual NodeType
00131     getNodeType() const;
00132 
00133     virtual XalanNode*
00134     getParentNode() const;
00135 
00136     virtual const XalanNodeList*
00137     getChildNodes() const;
00138 
00139     virtual XalanNode*
00140     getFirstChild() const;
00141 
00142     virtual XalanNode*
00143     getLastChild() const;
00144 
00145     virtual XalanNode*
00146     getPreviousSibling() const;
00147 
00148     virtual XalanNode*
00149     getNextSibling() const;
00150 
00151     virtual const XalanNamedNodeMap*
00152     getAttributes() const;
00153 
00154     virtual XalanDocument*
00155     getOwnerDocument() const;
00156 
00157 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00158     virtual XalanNode*
00159 #else
00160     virtual ResultTreeFrag*
00161 #endif
00162     cloneNode(bool deep) const;
00163 
00164     virtual XalanNode*
00165     insertBefore(
00166             XalanNode*  newChild,
00167             XalanNode*  refChild);
00168 
00169     virtual XalanNode*
00170     replaceChild(
00171             XalanNode*  newChild,
00172             XalanNode*  oldChild);
00173 
00174     virtual XalanNode*
00175     removeChild(XalanNode*  oldChild);
00176 
00177     virtual XalanNode*
00178     appendChild(XalanNode*  newChild);
00179 
00180     virtual bool
00181     hasChildNodes() const;
00182 
00183     virtual void
00184     setNodeValue(const XalanDOMString&  nodeValue);
00185 
00186     virtual void
00187     normalize();
00188 
00189     virtual bool
00190     isSupported(
00191             const XalanDOMString&   feature,
00192             const XalanDOMString&   version) const;
00193 
00194     virtual const XalanDOMString&
00195     getNamespaceURI() const;
00196 
00197     virtual const XalanDOMString&
00198     getPrefix() const;
00199 
00200     virtual const XalanDOMString&
00201     getLocalName() const;
00202 
00203     virtual void
00204     setPrefix(const XalanDOMString&     prefix);
00205 
00206     virtual bool
00207     isIndexed() const;
00208 
00209     virtual IndexType
00210     getIndex() const;
00211 
00212 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00213     virtual ResultTreeFragBase*
00214 #else
00215     virtual ResultTreeFrag*
00216 #endif
00217     clone(bool  deep) const;
00218 
00219     XalanSourceTreeDocumentFragment*
00220     getDocumentFragment() const
00221     {
00222         return m_documentFragment;
00223     }
00224 
00225     void
00226     setDocumentFragment(XalanSourceTreeDocumentFragment*    theDocumentFragment);
00227 
00228 private:
00229 
00230     // These methods are inherited from XalanNodeList...
00231 
00232     virtual XalanNode*
00233     item(unsigned int   index) const;
00234 
00235     virtual unsigned int
00236     getLength() const;
00237 
00238 
00239     // Not defined
00240     ResultTreeFrag&
00241     operator=(const ResultTreeFrag&     theRHS);
00242 
00243     bool
00244     operator==(const ResultTreeFrag&    theRHS) const;
00245 
00246     // Data members...
00247     XalanSourceTreeDocumentFragment*    m_documentFragment;
00248 
00249     // These are for caching results...
00250     mutable unsigned int                m_length;
00251 
00252     mutable unsigned int                m_lastIndex;
00253 
00254     mutable XalanNode*                  m_lastNode;
00255 
00256     static const XalanDOMString     s_emptyString;
00257 };
00258 
00259 
00260 
00261 XALAN_CPP_NAMESPACE_END
00262 
00263 
00264 
00265 #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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.