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  

StylesheetConstructionContext.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(STYLESHEETCONSTRUCTIONCONTEXT_HEADER_GUARD_1357924680)
00060 #define STYLESHEETCONSTRUCTIONCONTEXT_HEADER_GUARD_1357924680
00061 
00062 
00063 
00064 // Base include file.  Must be first.
00065 #include <XSLT/XSLTDefinitions.hpp>
00066 
00067 
00068 
00069 #include <PlatformSupport/URISupport.hpp>
00070 
00071 
00072 
00073 #include <XalanDOM/XalanDOMString.hpp>
00074 
00075 
00076 
00077 class DocumentHandler;
00078 class ElemTemplateElement;
00079 class Locator;
00080 class PrefixResolver;
00081 class Stylesheet;
00082 class StylesheetRoot;
00083 class XalanDocument;
00084 class XalanNode;
00085 class XPath;
00086 class XMLURL;
00087 class XSLTInputSource;
00088 
00089 
00090 
00091 //
00092 // An abstract class which provides support for constructing the internal
00093 // representation  of a stylesheet.
00094 //
00095 class XALAN_XSLT_EXPORT StylesheetConstructionContext
00096 {
00097 public:
00098 
00099     typedef URISupport::URLAutoPtrType  URLAutoPtrType;
00100 
00101     explicit
00102     StylesheetConstructionContext();
00103 
00104     virtual
00105     ~StylesheetConstructionContext();
00106 
00107 
00112     virtual void
00113     reset() = 0;
00114 
00123     virtual StylesheetRoot*
00124     create(const XalanDOMString&    theBaseIdentifier) = 0;
00125 
00134     virtual StylesheetRoot*
00135     create(const XSLTInputSource&   theInputSource) = 0;
00136 
00146     virtual Stylesheet*
00147     create(
00148             StylesheetRoot&         theStylesheetRoot,
00149             const XalanDOMString&   theBaseIdentifier) = 0;
00150 
00157     virtual void
00158     destroy(StylesheetRoot*     theStylesheetRoot) = 0;
00159 
00168     virtual int
00169     getAttrTok(const XalanDOMString&    name) const = 0;
00170 
00179     virtual int
00180     getAttrTok(const XalanDOMChar*  name) const = 0;
00181 
00188     virtual URLAutoPtrType
00189     getURLFromString(const XalanDOMString&  urlString) = 0;
00190 
00197     virtual XalanDOMString
00198     getURLStringFromString(const XalanDOMString&    urlString) = 0;
00199 
00207     virtual URLAutoPtrType
00208     getURLFromString(
00209             const XalanDOMString&   urlString,
00210             const XalanDOMString&   base) = 0;
00211 
00219     virtual XalanDOMString
00220     getURLStringFromString(
00221             const XalanDOMString&   urlString,
00222             const XalanDOMString&   base) = 0;
00223 
00230     virtual const XalanDOMString&
00231     getXSLTNamespaceURI() const = 0;
00232 
00243     virtual XPath*
00244     createMatchPattern(
00245             const Locator*          locator,
00246             const XalanDOMString&   str,
00247             const PrefixResolver&   resolver) = 0;
00248 
00259     virtual XPath*
00260     createMatchPattern(
00261             const Locator*          locator,
00262             const XalanDOMChar*     str,
00263             const PrefixResolver&   resolver) = 0;
00264 
00275     virtual XPath*
00276     createXPath(
00277             const Locator*          locator,
00278             const XalanDOMString&   str,
00279             const PrefixResolver&   resolver) = 0;
00280 
00291     virtual XPath*
00292     createXPath(
00293             const Locator*          locator,
00294             const XalanDOMChar*     str,
00295             const PrefixResolver&   resolver) = 0;
00296 
00302     virtual const Locator*
00303     getLocatorFromStack() const = 0;
00304 
00310     virtual void
00311     pushLocatorOnStack(const Locator*   locator) = 0;
00312 
00316     virtual void
00317     popLocatorStack() = 0;
00318 
00324     virtual const XalanDOMString&
00325     getXalanXSLNameSpaceURL() const = 0;
00326 
00338     virtual XalanDocument*
00339     parseXML(
00340             const XalanDOMString&   urlString,
00341             DocumentHandler*        docHandler, 
00342             XalanDocument*          docToRegister) = 0;
00343 
00352     virtual int
00353     getElementToken(const XalanDOMString&   name) const = 0;
00354 
00360     virtual double
00361     getXSLTVersionSupported() const = 0;
00362 
00363 
00364     // These interfaces are inherited from ExecutionContext...
00365 
00366     virtual void
00367     error(
00368             const XalanDOMString&       msg,
00369             const XalanNode*            sourceNode = 0,
00370             const ElemTemplateElement*  styleNode = 0) const = 0;
00371 
00372     virtual void
00373     error(
00374             const char*                 msg,
00375             const XalanNode*            sourceNode = 0,
00376             const ElemTemplateElement*  styleNode = 0) const = 0;
00377 
00378     virtual void
00379     warn(
00380             const XalanDOMString&       msg,
00381             const XalanNode*            sourceNode = 0,
00382             const ElemTemplateElement*  styleNode = 0) const = 0;
00383 
00384     virtual void
00385     warn(
00386             const char*                 msg,
00387             const XalanNode*            sourceNode = 0,
00388             const ElemTemplateElement*  styleNode = 0) const = 0;
00389 
00390     virtual void
00391     message(
00392             const XalanDOMString&       msg,
00393             const XalanNode*            sourceNode = 0,
00394             const ElemTemplateElement*  styleNode = 0) const = 0;
00395 
00396     virtual void
00397     message(
00398             const char*                 msg,
00399             const XalanNode*            sourceNode = 0,
00400             const ElemTemplateElement*  styleNode = 0) const = 0;
00401 };
00402 
00403 
00404 
00405 #endif  // STYLESHEETCONSTRUCTIONCONTEXT_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.