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 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 XObjectPtr;
00095 class XPathExecutionContext;
00096 class XSLTInputSource;
00097 class XSLTResultTarget;
00098 
00099 
00100 
00111 class XALAN_XSLT_EXPORT XSLTProcessor
00112 {
00113 public:
00114 
00115     XSLTProcessor();
00116 
00117     virtual
00118     ~XSLTProcessor();
00119 
00132     virtual void
00133     process(
00134         const XSLTInputSource&          inputSource,
00135         const XSLTInputSource&          stylesheetSource,
00136         XSLTResultTarget&               outputTarget,
00137         StylesheetConstructionContext&  constructionContext,
00138         StylesheetExecutionContext&     executionContext) = 0;
00139 
00151     virtual void
00152     process(
00153             const XSLTInputSource&          inputSource,
00154             XSLTResultTarget&               outputTarget,
00155             StylesheetExecutionContext&     executionContext) = 0;
00156 
00166     virtual StylesheetRoot*
00167     processStylesheet(
00168             const XSLTInputSource&          stylesheetSource,
00169             StylesheetConstructionContext&  constructionContext) = 0;
00170   
00180     virtual StylesheetRoot*
00181     processStylesheet(
00182             const XalanDOMString&           xsldocURLString,
00183             StylesheetConstructionContext&  constructionContext) = 0;
00184   
00189     virtual void
00190     reset() = 0;
00191   
00197     virtual XalanDocument*
00198     getDOMFactory() const = 0;
00199 
00206     virtual XalanNode*
00207     getSourceTreeFromInput(const XSLTInputSource&   inputSource) = 0;
00208 
00216     virtual void
00217     outputToResultTree(
00218             StylesheetExecutionContext&     executionContext,
00219             const XObject&                  xobj) = 0;
00220 
00228     virtual void
00229     resetCurrentState(
00230             XalanNode*  sourceTree,
00231             XalanNode*  xmlNode) = 0;
00232 
00238     virtual const StylesheetRoot*
00239     getStylesheetRoot() const = 0;
00240 
00246     virtual void
00247     setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;
00248 
00255     virtual void
00256     setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;
00257 
00271     virtual XalanDOMString
00272     evaluateAttrVal(
00273             XalanNode*              contextNode,
00274             const PrefixResolver&   namespaceContext,
00275             const XalanDOMString&   stringedValue,
00276             XPathExecutionContext&  executionContext) = 0;
00277 
00281     virtual void
00282     resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;
00283 
00289     virtual XMLParserLiaison&
00290     getXMLParserLiaison() const = 0;
00291 
00297     virtual const XalanDOMString
00298     getUniqueNamespaceValue() const = 0;
00299 
00305     virtual void
00306     getUniqueNamespaceValue(XalanDOMString&     theValue) const = 0;
00307 
00315    virtual void
00316    setStylesheetParam(
00317             const XalanDOMString&   key,
00318             XObjectPtr              value) = 0;
00319   
00327     virtual void
00328     setStylesheetParam(
00329             const XalanDOMString&   key,
00330             const XalanDOMString&   expression) = 0;
00331 
00345     virtual bool
00346     shouldStripSourceNode(
00347             XPathExecutionContext&  executionContext,
00348             const XalanNode&        node) const = 0;
00349 
00355     virtual FormatterListener*
00356     getFormatterListener() const = 0;
00357   
00363     virtual void
00364     setFormatterListener(FormatterListener*     flistener) = 0;  
00365 
00371     virtual unsigned long
00372     getTraceListeners() const = 0;
00373 
00379     virtual void
00380     addTraceListener(TraceListener*     tl) = 0;
00381 
00387     virtual void
00388     removeTraceListener(TraceListener*  tl) = 0;
00389 
00395     virtual void
00396     fireGenerateEvent(const GenerateEvent&  ge) = 0;
00397 
00403     virtual void
00404     fireTraceEvent(const TracerEvent&   te) = 0;
00405 
00411     virtual void
00412     fireSelectEvent(const SelectionEvent&   se) = 0;
00413 
00419     virtual bool
00420     getTraceSelects() const = 0;
00421 
00428     virtual void
00429     traceSelect(
00430             const XalanElement&     theTemplate,
00431             const NodeRefListBase&  nl) const = 0;
00432 
00441     virtual void
00442     setQuietConflictWarnings(bool b) = 0;
00443 
00452     virtual void
00453     setDiagnosticsOutput(PrintWriter* pw) = 0;
00454 
00462     virtual void
00463     message(
00464             const XalanDOMString&   msg,
00465             const XalanNode*        styleNode = 0,
00466             const XalanNode*        sourceNode = 0) const = 0;
00467 
00476     virtual void
00477     warn(
00478             const XalanDOMString&   msg,
00479             const XalanNode*        styleNode = 0,
00480             const XalanNode*        sourceNode = 0) const = 0;
00481 
00490     virtual void
00491     error(
00492             const XalanDOMString&   msg,
00493             const XalanNode*        styleNode = 0,
00494             const XalanNode*        sourceNode = 0) const = 0;
00495 };
00496 
00497 
00498 
00499 #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.