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 // Base class header file...
00070 #include <PlatformSupport/ExecutionContext.hpp>
00071 
00072 
00073 
00074 #include <PlatformSupport/URISupport.hpp>
00075 
00076 
00077 
00078 #include <XalanDOM/XalanDOMString.hpp>
00079 
00080 
00081 
00082 class DocumentHandler;
00083 class Locator;
00084 class PrefixResolver;
00085 class Stylesheet;
00086 class StylesheetRoot;
00087 class XalanDocument;
00088 class XPath;
00089 class XMLURL;
00090 class XSLTInputSource;
00091 
00092 
00093 
00094 //
00095 // An abstract class which provides support for constructing the internal
00096 // representation  of a stylesheet.
00097 //
00098 class XALAN_XSLT_EXPORT StylesheetConstructionContext : public ExecutionContext
00099 {
00100 public:
00101 
00102     typedef URISupport::URLAutoPtrType  URLAutoPtrType;
00103 
00104     explicit
00105     StylesheetConstructionContext();
00106 
00107     virtual
00108     ~StylesheetConstructionContext();
00109 
00110 
00115     virtual void
00116     reset() = 0;
00117 
00126     virtual StylesheetRoot*
00127     create(const XalanDOMString&    theBaseIdentifier) = 0;
00128 
00137     virtual StylesheetRoot*
00138     create(const XSLTInputSource&   theInputSource) = 0;
00139 
00149     virtual Stylesheet*
00150     create(
00151             StylesheetRoot&         theStylesheetRoot,
00152             const XalanDOMString&   theBaseIdentifier) = 0;
00153 
00160     virtual void
00161     destroy(StylesheetRoot*     theStylesheetRoot) = 0;
00162 
00171     virtual int
00172     getAttrTok(const XalanDOMString&    name) const = 0;
00173 
00182     virtual int
00183     getAttrTok(const XalanDOMChar*  name) const = 0;
00184 
00191     virtual URLAutoPtrType
00192     getURLFromString(const XalanDOMString&  urlString) = 0;
00193 
00200     virtual XalanDOMString
00201     getURLStringFromString(const XalanDOMString&    urlString) = 0;
00202 
00210     virtual URLAutoPtrType
00211     getURLFromString(
00212             const XalanDOMString&   urlString,
00213             const XalanDOMString&   base) = 0;
00214 
00222     virtual XalanDOMString
00223     getURLStringFromString(
00224             const XalanDOMString&   urlString,
00225             const XalanDOMString&   base) = 0;
00226 
00233     virtual const XalanDOMString&
00234     getXSLTNamespaceURI() const = 0;
00235 
00245     virtual XPath*
00246     createMatchPattern(
00247             const XalanDOMString&   str,
00248             const PrefixResolver&   resolver) = 0;
00249 
00259     virtual XPath*
00260     createMatchPattern(
00261             const XalanDOMChar*     str,
00262             const PrefixResolver&   resolver) = 0;
00263 
00273     virtual XPath*
00274     createXPath(
00275             const XalanDOMString&   str,
00276             const PrefixResolver&   resolver) = 0;
00277 
00287     virtual XPath*
00288     createXPath(
00289             const XalanDOMChar*     str,
00290             const PrefixResolver&   resolver) = 0;
00291 
00297     virtual const Locator*
00298     getLocatorFromStack() const = 0;
00299 
00305     virtual void
00306     pushLocatorOnStack(const Locator*   locator) = 0;
00307 
00311     virtual void
00312     popLocatorStack() = 0;
00313 
00319     virtual const XalanDOMString&
00320     getXalanXSLNameSpaceURL() const = 0;
00321 
00333     virtual XalanDocument*
00334     parseXML(
00335             const XalanDOMString&   urlString,
00336             DocumentHandler*        docHandler, 
00337             XalanDocument*          docToRegister) = 0;
00338 
00347     virtual int
00348     getElementToken(const XalanDOMString&   name) const = 0;
00349 
00355     virtual double
00356     getXSLTVersionSupported() const = 0;
00357 
00358 
00359     // These interfaces are inherited from ExecutionContext...
00360 
00361     virtual void
00362     error(
00363             const XalanDOMString&   msg,
00364             const XalanNode*        sourceNode = 0,
00365             const XalanNode*        styleNode = 0) const = 0;
00366 
00367     virtual void
00368     error(
00369             const char*         msg,
00370             const XalanNode*    sourceNode = 0,
00371             const XalanNode*    styleNode = 0) const = 0;
00372 
00373     virtual void
00374     warn(
00375             const XalanDOMString&   msg,
00376             const XalanNode*        sourceNode = 0,
00377             const XalanNode*        styleNode = 0) const = 0;
00378 
00379     virtual void
00380     warn(
00381             const char*         msg,
00382             const XalanNode*    sourceNode = 0,
00383             const XalanNode*    styleNode = 0) const = 0;
00384 
00385     virtual void
00386     message(
00387             const XalanDOMString&   msg,
00388             const XalanNode*        sourceNode = 0,
00389             const XalanNode*        styleNode = 0) const = 0;
00390 
00391     virtual void
00392     message(
00393             const char*         msg,
00394             const XalanNode*    sourceNode = 0,
00395             const XalanNode*    styleNode = 0) const = 0;
00396 };
00397 
00398 
00399 
00400 #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.