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  

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 ResultTreeFragBase;
00082 class SelectionEvent;
00083 class StylesheetConstructionContext;
00084 class StylesheetExecutionContext;
00085 class StylesheetRoot;
00086 class TraceListener;
00087 class TracerEvent;
00088 class XalanDocument;
00089 class XalanElement;
00090 class XalanNode;
00091 class XMLParserLiaison;
00092 class XObject;
00093 class XObjectPtr;
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         const XSLTInputSource&          inputSource,
00134         const XSLTInputSource&          stylesheetSource,
00135         XSLTResultTarget&               outputTarget,
00136         StylesheetConstructionContext&  constructionContext,
00137         StylesheetExecutionContext&     executionContext) = 0;
00138 
00150     virtual void
00151     process(
00152             const XSLTInputSource&          inputSource,
00153             XSLTResultTarget&               outputTarget,
00154             StylesheetExecutionContext&     executionContext) = 0;
00155 
00165     virtual StylesheetRoot*
00166     processStylesheet(
00167             const 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(const XSLTInputSource&   inputSource) = 0;
00207 
00215     virtual void
00216     outputToResultTree(
00217             StylesheetExecutionContext&     executionContext,
00218             const XObject&                  xobj) = 0;
00219 
00225     virtual const StylesheetRoot*
00226     getStylesheetRoot() const = 0;
00227 
00233     virtual void
00234     setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;
00235 
00242     virtual void
00243     setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;
00244 
00248     virtual void
00249     resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;
00250 
00256     virtual XMLParserLiaison&
00257     getXMLParserLiaison() const = 0;
00258 
00264     virtual const XalanDOMString
00265     getUniqueNamespaceValue() = 0;
00266 
00272     virtual void
00273     getUniqueNamespaceValue(XalanDOMString&     theValue) = 0;
00274 
00282    virtual void
00283    setStylesheetParam(
00284             const XalanDOMString&   key,
00285             XObjectPtr              value) = 0;
00286   
00294     virtual void
00295     setStylesheetParam(
00296             const XalanDOMString&   key,
00297             const XalanDOMString&   expression) = 0;
00298 
00312     virtual bool
00313     shouldStripSourceNode(
00314             XPathExecutionContext&  executionContext,
00315             const XalanNode&        node) const = 0;
00316 
00322     virtual FormatterListener*
00323     getFormatterListener() const = 0;
00324   
00330     virtual void
00331     setFormatterListener(FormatterListener*     flistener) = 0;  
00332 
00338     virtual unsigned long
00339     getTraceListeners() const = 0;
00340 
00346     virtual void
00347     addTraceListener(TraceListener*     tl) = 0;
00348 
00354     virtual void
00355     removeTraceListener(TraceListener*  tl) = 0;
00356 
00362     virtual void
00363     fireGenerateEvent(const GenerateEvent&  ge) = 0;
00364 
00370     virtual void
00371     fireTraceEvent(const TracerEvent&   te) = 0;
00372 
00378     virtual void
00379     fireSelectEvent(const SelectionEvent&   se) = 0;
00380 
00386     virtual bool
00387     getTraceSelects() const = 0;
00388 
00395     virtual void
00396     traceSelect(
00397             const XalanElement&     theTemplate,
00398             const NodeRefListBase&  nl) const = 0;
00399 
00408     virtual void
00409     setQuietConflictWarnings(bool b) = 0;
00410 
00419     virtual void
00420     setDiagnosticsOutput(PrintWriter* pw) = 0;
00421 
00429     virtual void
00430     message(
00431             const XalanDOMString&   msg,
00432             const XalanNode*        sourceNode = 0,
00433             const XalanNode*        styleNode = 0) const = 0;
00434 
00442     virtual void
00443     message(
00444             const XalanDOMString&       msg,
00445             const XalanNode*            sourceNode,
00446             const ElemTemplateElement*  styleNode) const = 0;
00447 
00455     virtual void
00456     warn(
00457             const XalanDOMString&   msg,
00458             const XalanNode*        sourceNode = 0,
00459             const XalanNode*        styleNode = 0) const = 0;
00460 
00468     virtual void
00469     warn(
00470             const XalanDOMString&       msg,
00471             const XalanNode*            sourceNode,
00472             const ElemTemplateElement*  styleNode) const = 0;
00473 
00481     virtual void
00482     error(
00483             const XalanDOMString&   msg,
00484             const XalanNode*        sourceNode = 0,
00485             const XalanNode*        styleNode = 0) const = 0;
00486 
00494     virtual void
00495     error(
00496             const XalanDOMString&       msg,
00497             const XalanNode*            sourceNode,
00498             const ElemTemplateElement*  styleNode) const = 0;
00499 };
00500 
00501 
00502 
00503 #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.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.