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  

XPathEvaluator.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 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(XPATHEVALUATOR_HEADER_GUARD_1357924680)
00058 #define XPATHEVALUATOR_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XPath/XPathDefinitions.hpp>
00063 
00064 
00065 
00066 #if defined(XALAN_AUTO_PTR_REQUIRES_DEFINITION)
00067 #include <XPath/XObjectFactory.hpp>
00068 #include <XPath/XPathExecutionContextDefault.hpp>
00069 #endif
00070 
00071 
00072 
00073 #include <Include/XalanAutoPtr.hpp>
00074 
00075 
00076 
00077 #include <XalanDOM/XalanDOMString.hpp>
00078 
00079 
00080 
00081 #if !defined(XALAN_AUTO_PTR_REQUIRES_DEFINITION)
00082 class XObjectFactory;
00083 class XPathExecutionContextDefault;
00084 #endif
00085 
00086 
00087 
00088 class DOMSupport;
00089 class NodeRefList;
00090 class PrefixResolver;
00091 class XalanNode;
00092 class XalanElement;
00093 class XObjectPtr;
00094 class XPathEnvSupport;
00095 
00096 
00097 
00098 class XALAN_XPATH_EXPORT XPathEvaluator
00099 {
00100 public:
00101 
00102     // Static initializer to be called before any instances are
00103     // created.
00104     static void
00105     initialize();
00106 
00107     // Static terminator to be called when after all instances
00108     // are destroyed.
00109     static void
00110     terminate();
00111 
00112 
00113     XPathEvaluator();
00114 
00115     ~XPathEvaluator();
00116 
00128     XalanNode*
00129     selectSingleNode(
00130             DOMSupport&             domSupport,
00131             XalanNode*              contextNode,
00132             const XalanDOMChar*     xpathString,
00133             const XalanElement*     namespaceNode = 0);
00134 
00146     XalanNode*
00147     selectSingleNode(
00148             DOMSupport&             domSupport,
00149             XalanNode*              contextNode,
00150             const XalanDOMChar*     xpathString,
00151             const PrefixResolver&   prefixResolver);
00152 
00163     NodeRefList
00164     selectNodeList(
00165             DOMSupport&             domSupport,
00166             XalanNode*              contextNode,
00167             const XalanDOMChar*     xpathString,
00168             const XalanElement*     namespaceNode = 0);
00169 
00180     NodeRefList
00181     selectNodeList(
00182             DOMSupport&             domSupport,
00183             XalanNode*              contextNode,
00184             const XalanDOMChar*     xpathString,
00185             const PrefixResolver&   prefixResolver);
00186 
00202     XObjectPtr
00203     evaluate(
00204             DOMSupport&             domSupport,
00205             XalanNode*              contextNode,
00206             const XalanDOMChar*     xpathString,
00207             const XalanElement*     namespaceNode = 0);
00208 
00224     XObjectPtr
00225     evaluate(
00226             DOMSupport&             domSupport,
00227             XalanNode*              contextNode,
00228             const XalanDOMChar*     xpathString,
00229             const PrefixResolver&   prefixResolver);
00230 
00231 private:
00232 
00244     XObjectPtr
00245     evaluate(
00246             DOMSupport&             domSupport,
00247             XalanNode*              contextNode,
00248             const XalanDOMChar*     xpathString,
00249             const PrefixResolver&   prefixResolver,
00250             XPathEnvSupport&        doEvaluate);
00251 
00252     // Data members...
00253     const XalanAutoPtr<XObjectFactory>                  m_xobjectFactory;
00254 
00255     const XalanAutoPtr<XPathExecutionContextDefault>    m_executionContext;
00256 };
00257 
00258 
00259 
00260 #endif  // XPATHEVALUATOR_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.