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  

XSLTProcessorEnvSupport.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  * @author <a href="mailto:david_n_bertoni@lotus.com">David N. Bertoni</a>
00058  */
00059 #if !defined(XSLTPROCESSORENVSUPPORT_HEADER_GUARD_1357924680)
00060 #define XSLTPROCESSORENVSUPPORT_HEADER_GUARD_1357924680
00061 
00062 
00063 
00064 // Base include file.  Must be first.
00065 #include <XSLT/XSLTDefinitions.hpp>
00066 
00067 
00068 
00069 // Base class header file...
00070 #include <XPath/XPathEnvSupport.hpp>
00071 
00072 
00073 
00074 class XSLTProcessor;
00075 
00076 
00077 
00078 class XALAN_XSLT_EXPORT XSLTProcessorEnvSupport : public XPathEnvSupport
00079 {
00080 public:
00081 
00082     XSLTProcessorEnvSupport();
00083 
00084     virtual
00085     ~XSLTProcessorEnvSupport();
00086 
00087 
00088     // These interfaces are inherited from XPathEnvSupport...
00089 
00090     virtual XalanDocument*
00091     parseXML(
00092             const XalanDOMString&   urlString,
00093             const XalanDOMString&   base) = 0;
00094 
00095     virtual XalanDocument*
00096     getSourceDocument(const XalanDOMString&     theURI) const = 0;
00097 
00098     virtual void
00099     setSourceDocument(
00100             const XalanDOMString&   theURI,
00101             XalanDocument*          theDocument) = 0;
00102 
00103     virtual XalanDOMString
00104     findURIFromDoc(const XalanDocument*     owner) const = 0;
00105 
00106     virtual XalanDocument*
00107     getDOMFactory() const = 0;
00108 
00109     virtual bool
00110     elementAvailable(
00111             const XalanDOMString&   theNamespace, 
00112             const XalanDOMString&   elementName) const = 0;
00113 
00114     virtual bool
00115     functionAvailable(
00116             const XalanDOMString&   theNamespace, 
00117             const XalanDOMString&   functionName) const = 0;
00118 
00119     virtual XObjectPtr
00120     extFunction(
00121             XPathExecutionContext&          executionContext,
00122             const XalanDOMString&           theNamespace,
00123             const XalanDOMString&           functionName,
00124             XalanNode*                      context,
00125             const XObjectArgVectorType&     argVec) const = 0;
00126 
00127     virtual XLocator*
00128     getXLocatorFromNode(const XalanNode*    node) const = 0;
00129 
00130     virtual void
00131     associateXLocatorToNode(
00132             const XalanNode*    node,
00133             XLocator*           xlocator) = 0;
00134 
00135     virtual bool
00136     shouldStripSourceNode(
00137             XPathExecutionContext&  executionContext,
00138             const XalanNode&        node) const = 0;
00139 
00140     virtual bool
00141     problem(
00142             eSource                 where,
00143             eClassification         classification,
00144             const XalanNode*        styleNode,
00145             const XalanNode*        sourceNode,
00146             const XalanDOMString&   msg,
00147             int                     lineNo,
00148             int                     charOffset) const = 0;
00149 
00150     virtual bool
00151     problem(
00152             eSource                 where,
00153             eClassification         classification,
00154             const PrefixResolver*   resolver,
00155             const XalanNode*        sourceNode,
00156             const XalanDOMString&   msg,
00157             int                     lineNo,
00158             int                     charOffset) const = 0;
00159 
00160     // These interfaces are inherited from Resettable...
00161 
00162     virtual void
00163     reset() = 0;
00164 
00165 private:
00166 
00167     // These are not implemented...
00168     XSLTProcessorEnvSupport(const XSLTProcessorEnvSupport&);
00169 
00170     XSLTProcessorEnvSupport&
00171     operator=(const XSLTProcessorEnvSupport&);
00172 
00173     bool
00174     operator==(const XSLTProcessorEnvSupport&) const;
00175 };
00176 
00177 
00178 
00179 #endif  // XSLTPROCESSORENVSUPPORT_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.