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  

FunctionID.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(FUNCTIONID_HEADER_GUARD_1357924680)
00058 #define FUNCTIONID_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <set>
00068 
00069 
00070 
00071 #include <XalanDOM/XalanElement.hpp>
00072 #include <XalanDOM/XalanNode.hpp>
00073 #include <XalanDOM/XalanDocument.hpp>
00074 
00075 
00076 
00077 // Base class header files...
00078 #include <XPath/Function.hpp>
00079 #include <XPath/XObjectTypeCallback.hpp>
00080 
00081 
00082 
00083 #include <PlatformSupport/DOMStringHelper.hpp>
00084 #include <PlatformSupport/StringTokenizer.hpp>
00085 
00086 
00087 
00088 #include <XPath/MutableNodeRefList.hpp>
00089 #include <XPath/NodeRefListBase.hpp>
00090 
00091 
00092 
00096 class XALAN_XPATH_EXPORT FunctionID : public Function
00097 {
00098 public:
00099 
00100     FunctionID();
00101 
00102     virtual
00103     ~FunctionID();
00104 
00105     // These methods are inherited from Function ...
00106 
00107     XObjectPtr
00108     execute(
00109             XPathExecutionContext&      executionContext,
00110             XalanNode*                  context);
00111 
00112     virtual XObjectPtr
00113     execute(
00114             XPathExecutionContext&      executionContext,
00115             XalanNode*                  context,            
00116             const XObjectPtr            arg1);
00117 
00118     XObjectPtr
00119     execute(
00120             XPathExecutionContext&      executionContext,
00121             XalanNode*                  context,            
00122             const XObjectPtr            /* arg1 */,
00123             const XObjectPtr            /* arg2 */);
00124 
00125     XObjectPtr
00126     execute(
00127             XPathExecutionContext&      executionContext,
00128             XalanNode*                  context,            
00129             const XObjectPtr            /* arg1 */,
00130             const XObjectPtr            /* arg2 */,
00131             const XObjectPtr            /* arg3 */);
00132 
00133     XObjectPtr
00134     execute(
00135             XPathExecutionContext&      executionContext,
00136             XalanNode*                  context,
00137             int                         /* opPos */,
00138             const XObjectArgVectorType& /* args */);
00139 
00140 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00141     virtual Function*
00142 #else
00143     virtual FunctionID*
00144 #endif
00145     clone() const;
00146 
00147 private:
00148 
00149     class FunctionIDXObjectTypeCallback : public XObjectTypeCallback
00150     {
00151     public:
00152 
00153         FunctionIDXObjectTypeCallback(XPathExecutionContext&    theExecutionContext);
00154 
00155         const XalanDOMString&
00156         processCallback(const XObject&  theXObject);
00157 
00158         // These methods are inherited from XObjectTypeCallback ...
00159 
00160         virtual void
00161         Number(
00162             const XObject&  theXObject,
00163             double          /* theValue */);
00164 
00165         virtual void
00166         Boolean(
00167             const XObject&  theXObject,
00168             bool            /* theValue */);
00169 
00170         virtual void
00171         String(
00172             const XObject&          theXObject,
00173             const XalanDOMString&   /* theValue */);
00174 
00175         virtual void
00176         ResultTreeFragment(
00177             const XObject&              theXObject,
00178             const ResultTreeFragBase&   /* theValue */);
00179 
00180         virtual void
00181         ResultTreeFragment(
00182             const XObject&          theXObject,
00183             ResultTreeFragBase&     /* theValue */);
00184 
00185         virtual void
00186         NodeSet(
00187             const XObject&          /* theXObject */,
00188             const NodeRefListBase&  theValue);
00189 
00190         virtual void
00191         Unknown(
00192             const XObject&          /* theObject */,
00193             const XalanDOMString&   /* theName */);
00194 
00195         virtual void
00196         Null(const XObject&     /* theObject */);
00197 
00198     private:
00199 
00200         XalanDOMString          m_resultString;
00201 
00202         XPathExecutionContext&  m_executionContext;
00203     };
00204 
00205     virtual const XalanDOMString
00206     getError() const;
00207 
00208     // Not implemented...
00209     FunctionID&
00210     operator=(const FunctionID&);
00211 
00212     bool
00213     operator==(const FunctionID&) const;
00214 };
00215 
00216 
00217 
00218 #endif  // FUNCTIONID_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.