Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

Main Page   Namespace List   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     virtual XObjectPtr
00108     execute(
00109             XPathExecutionContext&  executionContext,
00110             XalanNode*              context,
00111             const XObjectPtr        arg1,
00112             const Locator*          locator) const;
00113 
00114 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00115     virtual Function*
00116 #else
00117     virtual FunctionID*
00118 #endif
00119     clone() const;
00120 
00121 protected:
00122 
00123     const XalanDOMString
00124     getError() const;
00125 
00126 private:
00127 
00128     class FunctionIDXObjectTypeCallback : public XObjectTypeCallback
00129     {
00130     public:
00131 
00132         FunctionIDXObjectTypeCallback(XPathExecutionContext&    theExecutionContext);
00133 
00134         const XalanDOMString&
00135         processCallback(const XObject&  theXObject);
00136 
00137         // These methods are inherited from XObjectTypeCallback ...
00138 
00139         virtual void
00140         Number(
00141             const XObject&  theXObject,
00142             double          /* theValue */);
00143 
00144         virtual void
00145         Boolean(
00146             const XObject&  theXObject,
00147             bool            /* theValue */);
00148 
00149         virtual void
00150         String(
00151             const XObject&          theXObject,
00152             const XalanDOMString&   /* theValue */);
00153 
00154         virtual void
00155         ResultTreeFragment(
00156             const XObject&              theXObject,
00157             const ResultTreeFragBase&   /* theValue */);
00158 
00159         virtual void
00160         ResultTreeFragment(
00161             const XObject&          theXObject,
00162             ResultTreeFragBase&     /* theValue */);
00163 
00164         virtual void
00165         NodeSet(
00166             const XObject&          /* theXObject */,
00167             const NodeRefListBase&  theValue);
00168 
00169         virtual void
00170         Unknown(
00171             const XObject&          /* theObject */,
00172             const XalanDOMString&   /* theName */);
00173 
00174         virtual void
00175         Null(const XObject&     /* theObject */);
00176 
00177     private:
00178 
00179         XalanDOMString          m_resultString;
00180 
00181         XPathExecutionContext&  m_executionContext;
00182     };
00183 
00184     // Not implemented...
00185     FunctionID&
00186     operator=(const FunctionID&);
00187 
00188     bool
00189     operator==(const FunctionID&) const;
00190 };
00191 
00192 
00193 
00194 #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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.