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

FunctionID.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2003 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 <xalanc/XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <set>
00068 
00069 
00070 
00071 #include <xalanc/XalanDOM/XalanElement.hpp>
00072 #include <xalanc/XalanDOM/XalanNode.hpp>
00073 #include <xalanc/XalanDOM/XalanDocument.hpp>
00074 
00075 
00076 
00077 // Base class header files...
00078 #include <xalanc/XPath/Function.hpp>
00079 #include <xalanc/XPath/XObjectTypeCallback.hpp>
00080 
00081 
00082 
00083 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
00084 #include <xalanc/PlatformSupport/StringTokenizer.hpp>
00085 
00086 
00087 
00088 #include <xalanc/XPath/MutableNodeRefList.hpp>
00089 #include <xalanc/XPath/NodeRefListBase.hpp>
00090 
00091 
00092 
00093 XALAN_CPP_NAMESPACE_BEGIN
00094 
00095 
00096 
00100 class XALAN_XPATH_EXPORT FunctionID : public Function
00101 {
00102 public:
00103 
00104     typedef Function    ParentType;
00105 
00106     FunctionID();
00107 
00108     virtual
00109     ~FunctionID();
00110 
00111     // These methods are inherited from Function ...
00112 
00113     virtual XObjectPtr
00114     execute(
00115             XPathExecutionContext&  executionContext,
00116             XalanNode*              context,
00117             const XObjectPtr        arg1,
00118             const LocatorType*      locator) const;
00119 
00120 #if !defined(XALAN_NO_USING_DECLARATION)
00121     using ParentType::execute;
00122 #endif
00123 
00124 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00125     virtual Function*
00126 #else
00127     virtual FunctionID*
00128 #endif
00129     clone() const;
00130 
00131 protected:
00132 
00133     const XalanDOMString
00134     getError() const;
00135 
00136 private:
00137 
00138     class FunctionIDXObjectTypeCallback : public XObjectTypeCallback
00139     {
00140     public:
00141 
00142         FunctionIDXObjectTypeCallback(
00143                 XPathExecutionContext&  theExecutionContext,
00144                 XalanDOMString&         theString);
00145 
00146         void
00147         processCallback(const XObject&  theXObject);
00148 
00149         // These methods are inherited from XObjectTypeCallback ...
00150 
00151         virtual void
00152         Number(
00153             const XObject&  theXObject,
00154             double          /* theValue */);
00155 
00156         virtual void
00157         Boolean(
00158             const XObject&  theXObject,
00159             bool            /* theValue */);
00160 
00161         virtual void
00162         String(
00163             const XObject&          theXObject,
00164             const XalanDOMString&   /* theValue */);
00165 
00166         virtual void
00167         ResultTreeFragment(
00168             const XObject&              theXObject,
00169             const ResultTreeFragBase&   /* theValue */);
00170 
00171         virtual void
00172         ResultTreeFragment(
00173             const XObject&          theXObject,
00174             ResultTreeFragBase&     /* theValue */);
00175 
00176         virtual void
00177         NodeSet(
00178             const XObject&          /* theXObject */,
00179             const NodeRefListBase&  theValue);
00180 
00181         virtual void
00182         Unknown(
00183             const XObject&          /* theObject */,
00184             const XalanDOMString&   /* theName */);
00185 
00186         virtual void
00187         Null(const XObject&     /* theObject */);
00188 
00189     private:
00190 
00191         XalanDOMString&         m_resultString;
00192 
00193         XPathExecutionContext&  m_executionContext;
00194     };
00195 
00196     // Not implemented...
00197     FunctionID&
00198     operator=(const FunctionID&);
00199 
00200     bool
00201     operator==(const FunctionID&) const;
00202 };
00203 
00204 
00205 
00206 XALAN_CPP_NAMESPACE_END
00207 
00208 
00209 
00210 #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++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.