Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XPathSupport.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(XPATHSUPPORT_HEADER_GUARD_1357924680)
00058 #define XPATHSUPPORT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 #include <PlatformSupport/Resettable.hpp>
00072 
00073 
00074 
00075 class DocumentHandler;
00076 class XMLURL;
00077 class XalanDocument;
00078 class XalanElement;
00079 class XalanNode;
00080 class XalanText;
00081 
00082 
00083 
00084 class XALAN_XPATH_EXPORT XPathSupport : public Resettable
00085 {
00086 public:
00087 
00088     XPathSupport();
00089 
00090     virtual
00091     ~XPathSupport();
00092 
00100     virtual bool
00101     isIgnorableWhitespace(const XalanText&  node) const = 0;
00102 
00110     virtual XalanDOMString
00111     getNamespaceForPrefix(
00112             const XalanDOMString&   prefix, 
00113             const XalanElement&     namespaceContext) const = 0;
00114 
00121     virtual XalanDOMString
00122     getNamespaceOfNode(const XalanNode&     n) const = 0;
00123 
00132     virtual XalanDOMString
00133     getNameOfNode(const XalanNode&  n) const = 0;
00134 
00141     virtual XalanDOMString
00142     getLocalNameOfNode(const XalanNode&     n) const = 0;
00143 
00153     virtual XalanDOMString
00154     getNodeData(const XalanNode&    n) const = 0;
00155 
00163     virtual XalanNode*
00164     getParentOfNode(const XalanNode&    n) const = 0;
00165 
00173     virtual bool
00174     isNodeAfter(
00175             const XalanNode&    node1,
00176             const XalanNode&    node2) const = 0;
00177 
00185     virtual XalanElement*
00186     getElementByID(
00187             const XalanDOMString&   id,
00188             const XalanDocument&    doc) const = 0;
00189 
00196     virtual void
00197     setProcessNamespaces(bool   processNamespaces) = 0;
00198 
00204     virtual bool
00205     getProcessNamespaces() const = 0;
00206 
00217      // Since it states in the DOM draft: "An XML processor may choose to
00218      // completely expand entities before the structure model is passed to the
00219      // DOM; in this case, there will be no EntityReferences in the DOM tree."
00220      // So I'm not sure how well this is going to work.
00221     virtual XalanDOMString
00222     getUnparsedEntityURI(
00223             const XalanDOMString&   theName,
00224             const XalanDocument&    theDocument) const = 0;
00225 
00226 
00227     // These interfaces are inherited from Resettable...
00228 
00229     virtual void
00230     reset() = 0;
00231 
00232 private:
00233 
00234     // These are not implemented...
00235     XPathSupport(const XPathSupport&);
00236 
00237     XPathSupport&
00238     operator=(const XPathSupport&);
00239 
00240     bool
00241     operator==(const XPathSupport&);
00242 };
00243 
00244 
00245 
00246 #endif  // XPATHSUPPORT_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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.