Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

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-2002 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 <cstddef>
00072 
00073 
00074 
00075 XALAN_DECLARE_XERCES_CLASS(Locator)
00076 
00077 
00078 
00079 XALAN_CPP_NAMESPACE_BEGIN
00080 
00081 
00082 
00083 typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator  LocatorType;
00084 
00085 
00086 
00087 class ElemTemplateElement;
00088 class FormatterListener;
00089 class GenerateEvent;
00090 class NodeRefListBase;
00091 class PrefixResolver;
00092 class PrintWriter;
00093 class ResultTreeFragBase;
00094 class SelectionEvent;
00095 class StylesheetConstructionContext;
00096 class StylesheetExecutionContext;
00097 class StylesheetRoot;
00098 class TraceListener;
00099 class TracerEvent;
00100 class XalanDOMString;
00101 class XalanDocument;
00102 class XalanElement;
00103 class XalanNode;
00104 class XMLParserLiaison;
00105 class XObject;
00106 class XObjectPtr;
00107 class XPath;
00108 class XPathExecutionContext;
00109 class XSLTInputSource;
00110 class XSLTResultTarget;
00111 
00112 
00113 
00124 class XALAN_XSLT_EXPORT XSLTProcessor
00125 {
00126 public:
00127 
00128     typedef size_t  size_type;
00129 
00130     XSLTProcessor();
00131 
00132     virtual
00133     ~XSLTProcessor();
00134 
00147     virtual void
00148     process(
00149         const XSLTInputSource&          inputSource,
00150         const XSLTInputSource&          stylesheetSource,
00151         XSLTResultTarget&               outputTarget,
00152         StylesheetConstructionContext&  constructionContext,
00153         StylesheetExecutionContext&     executionContext) = 0;
00154 
00166     virtual void
00167     process(
00168             const XSLTInputSource&          inputSource,
00169             XSLTResultTarget&               outputTarget,
00170             StylesheetExecutionContext&     executionContext) = 0;
00171 
00181     virtual StylesheetRoot*
00182     processStylesheet(
00183             const XSLTInputSource&          stylesheetSource,
00184             StylesheetConstructionContext&  constructionContext) = 0;
00185   
00195     virtual StylesheetRoot*
00196     processStylesheet(
00197             const XalanDOMString&           xsldocURLString,
00198             StylesheetConstructionContext&  constructionContext) = 0;
00199   
00204     virtual void
00205     reset() = 0;
00206   
00213     virtual XalanNode*
00214     getSourceTreeFromInput(const XSLTInputSource&   inputSource) = 0;
00215 
00221     virtual const StylesheetRoot*
00222     getStylesheetRoot() const = 0;
00223 
00229     virtual void
00230     setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;
00231 
00238     virtual void
00239     setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;
00240 
00244     virtual void
00245     resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;
00246 
00252     virtual XMLParserLiaison&
00253     getXMLParserLiaison() const = 0;
00254 
00260     virtual const XalanDOMString
00261     getUniqueNamespaceValue() = 0;
00262 
00268     virtual void
00269     getUniqueNamespaceValue(XalanDOMString&     theValue) = 0;
00270 
00278    virtual void
00279    setStylesheetParam(
00280             const XalanDOMString&   key,
00281             XObjectPtr              value) = 0;
00282   
00290     virtual void
00291     setStylesheetParam(
00292             const XalanDOMString&   key,
00293             const XalanDOMString&   expression) = 0;
00294 
00308     virtual bool
00309     shouldStripSourceNode(
00310             StylesheetExecutionContext&     executionContext,
00311             const XalanNode&                node) const = 0;
00312 
00318     virtual FormatterListener*
00319     getFormatterListener() const = 0;
00320   
00326     virtual void
00327     setFormatterListener(FormatterListener*     flistener) = 0;  
00328 
00334     virtual size_type
00335     getTraceListeners() const = 0;
00336 
00342     virtual void
00343     addTraceListener(TraceListener*     tl) = 0;
00344 
00350     virtual void
00351     removeTraceListener(TraceListener*  tl) = 0;
00352 
00358     virtual void
00359     fireGenerateEvent(const GenerateEvent&  ge) = 0;
00360 
00366     virtual void
00367     fireTraceEvent(const TracerEvent&   te) = 0;
00368 
00374     virtual void
00375     fireSelectEvent(const SelectionEvent&   se) = 0;
00376 
00382     virtual bool
00383     getTraceSelects() const = 0;
00384 
00393     virtual void
00394     traceSelect(
00395             StylesheetExecutionContext&     executionContext,
00396             const ElemTemplateElement&      theStylesheetElement,
00397             const NodeRefListBase&          nl,
00398             const XPath*                    xpath) 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 ElemTemplateElement*  styleNode = 0) const = 0;
00434 
00442     virtual void
00443     message(
00444             const XalanDOMString&   msg,
00445             const LocatorType&      locator,
00446             const XalanNode*        sourceNode = 0) const = 0;
00447 
00455     virtual void
00456     warn(
00457             const XalanDOMString&       msg,
00458             const XalanNode*            sourceNode = 0,
00459             const ElemTemplateElement*  styleNode = 0) const = 0;
00460 
00468     virtual void
00469     warn(
00470             const XalanDOMString&   msg,
00471             const LocatorType&      locator,
00472             const XalanNode*        sourceNode = 0) const = 0;
00473 
00474 
00482     virtual void
00483     error(
00484             const XalanDOMString&       msg,
00485             const XalanNode*            sourceNode = 0,
00486             const ElemTemplateElement*  styleNode = 0) const = 0;
00487 
00495     virtual void
00496     error(
00497             const XalanDOMString&   msg,
00498             const LocatorType&      locator,
00499             const XalanNode*        sourceNode = 0) const = 0;
00500 };
00501 
00502 
00503 
00504 XALAN_CPP_NAMESPACE_END
00505 
00506 
00507 
00508 #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++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.