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  

XResultTreeFrag.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(XRESULTTREEFRAG_HEADER_GUARD_1357924680)
00058 #define XRESULTTREEFRAG_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 #if defined(XALAN_AUTO_PTR_REQUIRES_DEFINITION)
00072 #include <XPath/ResultTreeFragBase.hpp>
00073 #endif
00074 
00075 
00076 
00077 #include <Include/XalanAutoPtr.hpp>
00078 
00079 
00080 
00081 // Base class header file.
00082 #include <XPath/NodeRefListBase.hpp>
00083 #include <XPath/XObject.hpp>
00084 
00085 
00086 
00087 #include <XPath/XPathExecutionContext.hpp>
00088 
00089 
00090 
00091 class ResultTreeFragBase;
00092 class XResultTreeFrag;
00093 
00094 
00095 class XALAN_XPATH_EXPORT XResultTreeFrag : public XObject
00096 {
00097 public:
00098 
00099     typedef XObject                                             ParentType;
00100     typedef XPathExecutionContext::BorrowReturnResultTreeFrag   BorrowReturnResultTreeFrag;
00101 
00102 
00108     XResultTreeFrag(BorrowReturnResultTreeFrag&     val);
00109 
00116     XResultTreeFrag(const XResultTreeFrag&  source,
00117             bool                            deepClone = false);
00118 
00119     virtual
00120     ~XResultTreeFrag();
00121 
00122 
00123     // These methods are inherited from XObject ...
00124 
00125 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00126     virtual XObject*
00127 #else
00128     virtual XResultTreeFrag*
00129 #endif
00130     clone(void*     theAddress = 0) const;
00131 
00132     virtual XalanDOMString
00133     getTypeString() const;
00134   
00135     virtual double
00136     num() const;
00137 
00138     virtual bool
00139     boolean() const;
00140 
00141     virtual const XalanDOMString&
00142     str() const;
00143 
00144     virtual void
00145     str(
00146             FormatterListener&  formatterListener,
00147             MemberFunctionPtr   function) const;
00148 
00149     virtual void
00150     str(XalanDOMString& theBuffer) const;
00151 
00152     virtual const ResultTreeFragBase&
00153     rtree(XPathExecutionContext&    executionContext) const;
00154 
00155     virtual const ResultTreeFragBase&
00156     rtree() const;
00157 
00158     virtual const NodeRefListBase&
00159     nodeset() const;
00160 
00161     virtual void
00162     ProcessXObjectTypeCallback(XObjectTypeCallback&     theCallbackObject);
00163 
00164     virtual void
00165     ProcessXObjectTypeCallback(XObjectTypeCallback&     theCallbackObject) const;
00166 
00170     void
00171     release();
00172 
00178     void
00179     set(BorrowReturnResultTreeFrag& theValue);
00180 
00181     // This is a proxy class for result tree fragment to node-set
00182     // conversion.
00183     class XALAN_XPATH_EXPORT NodeRefListBaseProxy : public NodeRefListBase
00184     {
00185     public:
00186 
00187         NodeRefListBaseProxy(const XResultTreeFrag&     theXResultTreeFrag);
00188 
00189         virtual
00190         ~NodeRefListBaseProxy();
00191 
00192         virtual XalanNode*
00193         item(unsigned int   index) const;
00194 
00195         virtual unsigned int
00196         getLength() const;
00197 
00198         virtual unsigned int
00199         indexOf(const XalanNode*    theNode) const;
00200 
00201     private:
00202 
00203         // Not implemented...
00204         NodeRefListBaseProxy(const NodeRefListBaseProxy&);
00205 
00206         const XResultTreeFrag&  m_xresultTreeFrag;      
00207     };
00208 
00209     friend class NodeRefListBaseProxy;
00210 
00211 private:
00212 
00213     // New member functions for node list compatibility...
00214     XalanNode*
00215     item(unsigned int   index) const;
00216 
00217     unsigned int
00218     getLength() const;
00219 
00220     unsigned int
00221     indexOf(const XalanNode*    theNode) const;
00222 
00223 
00224     // Data members...
00225     BorrowReturnResultTreeFrag      m_value;    
00226 
00227     mutable XalanDOMString          m_cachedStringValue;
00228 
00229     mutable double                  m_cachedNumberValue;
00230 
00231 #if XALAN_RTREEFRAG_TO_NODESET_CONVERSION
00232     const NodeRefListBaseProxy      m_nodeRefListBaseProxy;
00233 #endif
00234 };
00235 
00236 
00237 
00238 #endif  // XRESULTTREEFRAG_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.