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  

XSLTProcessor.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  * $ Id: $
00058  *
00059  */
00060 
00061 #if !defined(XALAN_XSLTPROCESSOR_HEADER_GUARD)
00062 #define XALAN_XSLTPROCESSOR_HEADER_GUARD
00063 
00064 
00065 
00066 // Base include file.  Must be first.
00067 #include "XSLTDefinitions.hpp"
00068 
00069 
00070 
00071 #include <XalanDOM/XalanDOMString.hpp>
00072 
00073 
00074 
00075 class ElemTemplateElement;
00076 class FormatterListener;
00077 class GenerateEvent;
00078 class NodeRefListBase;
00079 class PrefixResolver;
00080 class PrintWriter;
00081 class QName;
00082 class ResultTreeFragBase;
00083 class SelectionEvent;
00084 class StylesheetConstructionContext;
00085 class StylesheetExecutionContext;
00086 class StylesheetRoot;
00087 class TraceListener;
00088 class TracerEvent;
00089 class XalanDocument;
00090 class XalanElement;
00091 class XalanNode;
00092 class XMLParserLiaison;
00093 class XObject;
00094 class XPathExecutionContext;
00095 class XSLTInputSource;
00096 class XSLTResultTarget;
00097 
00098 
00099 
00110 class XALAN_XSLT_EXPORT XSLTProcessor
00111 {
00112 public:
00113 
00114     XSLTProcessor();
00115 
00116     virtual
00117     ~XSLTProcessor();
00118 
00131     virtual void
00132     process(
00133         XSLTInputSource&                inputSource, 
00134         XSLTInputSource&                stylesheetSource,
00135         XSLTResultTarget&               outputTarget,
00136         StylesheetConstructionContext&  constructionContext,
00137         StylesheetExecutionContext&     executionContext) = 0;
00138 
00150     virtual void
00151     process(
00152             XSLTInputSource&                inputSource, 
00153             XSLTResultTarget&               outputTarget,
00154             StylesheetExecutionContext&     executionContext) = 0;
00155 
00165     virtual StylesheetRoot*
00166     processStylesheet(
00167             XSLTInputSource&                stylesheetSource,
00168             StylesheetConstructionContext&  constructionContext) = 0;
00169   
00179     virtual StylesheetRoot*
00180     processStylesheet(
00181             const XalanDOMString&           xsldocURLString,
00182             StylesheetConstructionContext&  constructionContext) = 0;
00183   
00188     virtual void
00189     reset() = 0;
00190   
00196     virtual XalanDocument*
00197     getDOMFactory() const = 0;
00198 
00205     virtual XalanNode*
00206     getSourceTreeFromInput(XSLTInputSource&     inputSource) = 0;
00207 
00215     virtual void
00216     outputToResultTree(
00217             StylesheetExecutionContext&     executionContext,
00218             const XObject&                  xobj) = 0;
00219 
00227     virtual void
00228     resetCurrentState(
00229             XalanNode*  sourceTree,
00230             XalanNode*  xmlNode) = 0;
00231 
00237     virtual const StylesheetRoot*
00238     getStylesheetRoot() const = 0;
00239 
00245     virtual void
00246     setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;
00247 
00254     virtual void
00255     setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;
00256 
00270     virtual XalanDOMString
00271     evaluateAttrVal(
00272             XalanNode*              contextNode,
00273             const PrefixResolver&   namespaceContext,
00274             const XalanDOMString&   stringedValue,
00275             XPathExecutionContext&  executionContext) = 0;
00276 
00288     virtual ResultTreeFragBase*
00289     createResultTreeFrag(
00290             StylesheetExecutionContext&     executionContext,
00291             const ElemTemplateElement&      templateChild,
00292             XalanNode*                      sourceTree,
00293             XalanNode*                      sourceNode,
00294             const QName&                    mode) = 0;
00295 
00301     virtual ResultTreeFragBase*
00302     createResultTreeFrag() const = 0;
00303 
00307     virtual void
00308     resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;
00309 
00315    virtual XMLParserLiaison&
00316    getXMLParserLiaison() const = 0;
00317 
00323    virtual const XalanDOMString
00324    getUniqueNSValue() const = 0;
00325 
00333    virtual void
00334    setStylesheetParam(
00335             const XalanDOMString&   key,
00336             XObject*                value) = 0;
00337   
00345     virtual void
00346     setStylesheetParam(
00347             const XalanDOMString&   key,
00348             const XalanDOMString&   expression) = 0;
00349 
00363     virtual bool
00364     shouldStripSourceNode(
00365             XPathExecutionContext&  executionContext,
00366             const XalanNode&        node) const = 0;
00367 
00373     virtual FormatterListener*
00374     getFormatterListener() const = 0;
00375   
00381     virtual void
00382     setFormatterListener(FormatterListener*     flistener) = 0;  
00383 
00389     virtual unsigned long
00390     getTraceListeners() const = 0;
00391 
00397     virtual void
00398     addTraceListener(TraceListener*     tl) = 0;
00399 
00405     virtual void
00406     removeTraceListener(TraceListener*  tl) = 0;
00407 
00413     virtual void
00414     fireGenerateEvent(const GenerateEvent&  ge) = 0;
00415 
00421     virtual void
00422     fireTraceEvent(const TracerEvent&   te) = 0;
00423 
00429     virtual void
00430     fireSelectEvent(const SelectionEvent&   se) = 0;
00431 
00437     virtual bool
00438     getTraceSelects() const = 0;
00439 
00446     virtual void
00447     traceSelect(
00448             const XalanElement&     theTemplate,
00449             const NodeRefListBase&  nl) const = 0;
00450 
00459     virtual void
00460     setQuietConflictWarnings(bool b) = 0;
00461 
00470     virtual void
00471     setDiagnosticsOutput(PrintWriter* pw) = 0;
00472 
00480     virtual void
00481     message(
00482             const XalanDOMString&   msg,
00483             const XalanNode*        styleNode = 0,
00484             const XalanNode*        sourceNode = 0) const = 0;
00485 
00494     virtual void
00495     warn(
00496             const XalanDOMString&   msg,
00497             const XalanNode*        styleNode = 0,
00498             const XalanNode*        sourceNode = 0) const = 0;
00499 
00508     virtual void
00509     error(
00510             const XalanDOMString&   msg,
00511             const XalanNode*        styleNode = 0,
00512             const XalanNode*        sourceNode = 0) const = 0;
00513 };
00514 
00515 
00516 
00517 #endif  // XALAN_XSLTPROCESSOR_HEADER_GUARD

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.