Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.3

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-2001 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 <XSLT/XSLTDefinitions.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 <XSLT/StylesheetExecutionContext.hpp>
00088 
00089 
00090 
00091 class ResultTreeFrag;
00092 
00093 
00094 
00095 class XALAN_XSLT_EXPORT XResultTreeFrag : public XObject
00096 {
00097 public:
00098 
00099     typedef XObject                                                 ParentType;
00100 
00101 
00107     XResultTreeFrag(ResultTreeFragBase&     value);
00108 
00115     XResultTreeFrag(
00116             const XResultTreeFrag&  source,
00117             bool                    deepClone = false);
00118 
00119     virtual
00120     ~XResultTreeFrag();
00121 
00122 
00123     void
00124     setExecutionContext(StylesheetExecutionContext*     theExecutionContext)
00125     {
00126         m_executionContext = theExecutionContext;
00127     }
00128 
00129     // These methods are inherited from XObject ...
00130 
00131 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00132     virtual XObject*
00133 #else
00134     virtual XResultTreeFrag*
00135 #endif
00136     clone(void*     theAddress = 0) const;
00137 
00138     virtual XalanDOMString
00139     getTypeString() const;
00140   
00141     virtual double
00142     num() const;
00143 
00144     virtual bool
00145     boolean() const;
00146 
00147     virtual const XalanDOMString&
00148     str() const;
00149 
00150     virtual void
00151     str(
00152             FormatterListener&  formatterListener,
00153             MemberFunctionPtr   function) const;
00154 
00155     virtual void
00156     str(XalanDOMString& theBuffer) const;
00157 
00158     virtual const ResultTreeFragBase&
00159     rtree() const;
00160 
00161     virtual const NodeRefListBase&
00162     nodeset() const;
00163 
00164     virtual void
00165     ProcessXObjectTypeCallback(XObjectTypeCallback&     theCallbackObject);
00166 
00167     virtual void
00168     ProcessXObjectTypeCallback(XObjectTypeCallback&     theCallbackObject) const;
00169 
00173     ResultTreeFragBase*
00174     release();
00175 
00181     void
00182     set(ResultTreeFragBase*     theValue);
00183 
00184     // This is a proxy class for result tree fragment to node-set
00185     // conversion.
00186     class XALAN_XSLT_EXPORT NodeRefListBaseProxy : public NodeRefListBase
00187     {
00188     public:
00189 
00190         NodeRefListBaseProxy(const XResultTreeFrag&     theXResultTreeFrag);
00191 
00192         virtual
00193         ~NodeRefListBaseProxy();
00194 
00195         virtual XalanNode*
00196         item(size_type  index) const;
00197 
00198         virtual size_type
00199         getLength() const;
00200 
00201         virtual size_type
00202         indexOf(const XalanNode*    theNode) const;
00203 
00204     private:
00205 
00206         // Not implemented...
00207         NodeRefListBaseProxy(const NodeRefListBaseProxy&);
00208 
00209         const XResultTreeFrag&  m_xresultTreeFrag;      
00210     };
00211 
00212     friend class NodeRefListBaseProxy;
00213 
00214 protected:
00215 
00216     virtual void 
00217     dereferenced();
00218 
00219 private:
00220 
00221     // New member functions for node list compatibility...
00222     XalanNode*
00223     item(unsigned int   index) const;
00224 
00225     unsigned int
00226     getLength() const;
00227 
00228     unsigned int
00229     indexOf(const XalanNode*    theNode) const;
00230 
00231 
00232     // Data members...
00233     ResultTreeFragBase*             m_value;    
00234 
00235     StylesheetExecutionContext*     m_executionContext;
00236 
00237     mutable XalanDOMString          m_cachedStringValue;
00238 
00239     mutable double                  m_cachedNumberValue;
00240 };
00241 
00242 
00243 
00244 #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++ XSLT Processor Version 1.3
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.