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  

XObjectFactory.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(XOBJECTFACTORY_HEADER_GUARD_1357924680)
00058 #define XOBJECTFACTORY_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <algorithm>
00068 #include <cassert>
00069 #include <set>
00070 
00071 
00072 
00073 #include <XPath/XObject.hpp>
00074 #include <XPath/XPathExecutionContext.hpp>
00075 
00076 
00077 
00078 class XalanNode;
00079 class MutableNodeRefList;
00080 class NodeRefListBase;
00081 class ResultTreeFragBase;
00082 class XObject;
00083 class XObjectPtr;
00084 class XToken;
00085 
00086 
00087 
00091 class XALAN_XPATH_EXPORT XObjectFactory
00092 {
00093 public:
00094 
00095     typedef XPathExecutionContext::BorrowReturnMutableNodeRefList   BorrowReturnMutableNodeRefList;
00096     typedef XPathExecutionContext::BorrowReturnResultTreeFrag       BorrowReturnResultTreeFrag;
00097     typedef XPathExecutionContext::GetAndReleaseCachedString        GetAndReleaseCachedString;
00098 
00099 
00100     XObjectFactory();
00101 
00102     virtual
00103     ~XObjectFactory();
00104 
00105 
00112     bool
00113     returnObject(XObject*   theXObject)
00114     {
00115         return doReturnObject(theXObject);
00116     }
00117 
00122     virtual void
00123     reset() = 0;
00124 
00131     virtual const XObjectPtr
00132     createBoolean(bool  theValue) = 0;
00133 
00140     virtual const XObjectPtr
00141     createNodeSet(BorrowReturnMutableNodeRefList&   theValue) = 0;
00142 
00149     virtual const XObjectPtr
00150     createNull() = 0;
00151 
00158     virtual const XObjectPtr
00159     createNumber(double     theValue) = 0;
00160 
00169     virtual const XObjectPtr
00170     createNumber(const XToken&  theValue) = 0;
00171 
00178     virtual const XObjectPtr
00179     createString(const XalanDOMString&  theValue) = 0;
00180 
00187     virtual const XObjectPtr
00188     createString(const XalanDOMChar*    theValue) = 0;
00189 
00197     virtual const XObjectPtr
00198     createString(
00199             const XalanDOMChar*     theValue,
00200             unsigned int            theLength) = 0;
00201 
00210     virtual const XObjectPtr
00211     createString(const XToken&  theValue) = 0;
00212 
00222     virtual const XObjectPtr
00223     createStringReference(const XalanDOMString&     theValue) = 0;
00224 
00233     virtual const XObjectPtr
00234     createStringAdapter(const XObjectPtr&   theValue) = 0;
00235 
00242     virtual const XObjectPtr
00243     createString(GetAndReleaseCachedString&     theValue) = 0;
00244 
00251     virtual const XObjectPtr
00252     createUnknown(const XalanDOMString&     theValue) = 0;
00253 
00260     virtual const XObjectPtr
00261     createResultTreeFrag(BorrowReturnResultTreeFrag&    theValue) = 0;
00262 
00269     virtual const XObjectPtr
00270     createSpan(BorrowReturnMutableNodeRefList&  theValue) = 0;
00271 
00277 #if defined(XALAN_NO_NAMESPACES)
00278     struct DeleteXObjectFunctor : public unary_function<XObject*, void>
00279 #else
00280     struct DeleteXObjectFunctor : public std::unary_function<XObject*, void>
00281 #endif
00282     {
00283     public:
00284 
00285         DeleteXObjectFunctor(
00286             XObjectFactory&     theFactoryInstance,
00287             bool                fInReset = false) :
00288             m_factoryInstance(theFactoryInstance),
00289             m_fInReset(fInReset)
00290         {
00291         }
00292 
00293         result_type
00294         operator()(argument_type    theXObject) const
00295         {
00296             if (m_fInReset == true)
00297             {
00298                 m_factoryInstance.doReturnObject(
00299                     theXObject,
00300                     true);
00301             }
00302             else
00303             {
00304                 m_factoryInstance.returnObject(theXObject);
00305             }
00306         }
00307 
00308     private:
00309 
00310         XObjectFactory&     m_factoryInstance;
00311 
00312         const bool          m_fInReset;
00313     };
00314 
00315     friend struct DeleteXObjectFunctor;
00316 
00317 protected:
00318 
00324     XObject::eObjectType
00325     getRealType(const XObject&  theXObject) const
00326     {
00327         return theXObject.getRealType();
00328     }
00329 
00335     void
00336     deleteObject(const XObject*     theXObject) const
00337     {
00338 #if defined(XALAN_CANNOT_DELETE_CONST)
00339         delete (XObject*)theXObject;
00340 #else
00341         delete theXObject;
00342 #endif
00343     }
00344 
00351 
00352     virtual bool
00353     doReturnObject(
00354             XObject*    theXObject,
00355             bool        fInReset = false) = 0;
00356 
00357 private:
00358 
00359     // Not implemented...
00360     XObjectFactory(const XObjectFactory&);
00361 
00362     XObjectFactory&
00363     operator=(const XObjectFactory&);
00364 
00365     bool
00366     operator==(const XObjectFactory&) const;
00367 };
00368 
00369 
00370 
00371 #endif  // XOBJECTFACTORY_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.