Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

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-2004 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 SelectionEvent;
00094 class StylesheetConstructionContext;
00095 class StylesheetExecutionContext;
00096 class StylesheetRoot;
00097 class TraceListener;
00098 class TracerEvent;
00099 class XalanDOMString;
00100 class XalanDocument;
00101 class XalanElement;
00102 class XalanNode;
00103 class XMLParserLiaison;
00104 class XObject;
00105 class XObjectPtr;
00106 class XPath;
00107 class XPathExecutionContext;
00108 class XSLTInputSource;
00109 class XSLTResultTarget;
00110 
00111 
00112 
00123 class XALAN_XSLT_EXPORT XSLTProcessor
00124 {
00125 public:
00126 
00127     typedef size_t  size_type;
00128 
00129     XSLTProcessor();
00130 
00131     virtual
00132     ~XSLTProcessor();
00133 
00146     virtual void
00147     process(
00148         const XSLTInputSource&          inputSource,
00149         const XSLTInputSource&          stylesheetSource,
00150         XSLTResultTarget&               outputTarget,
00151         StylesheetConstructionContext&  constructionContext,
00152         StylesheetExecutionContext&     executionContext) = 0;
00153 
00165     virtual void
00166     process(
00167             const XSLTInputSource&          inputSource,
00168             XSLTResultTarget&               outputTarget,
00169             StylesheetExecutionContext&     executionContext) = 0;
00170 
00180     virtual StylesheetRoot*
00181     processStylesheet(
00182             const XSLTInputSource&          stylesheetSource,
00183             StylesheetConstructionContext&  constructionContext) = 0;
00184   
00194     virtual StylesheetRoot*
00195     processStylesheet(
00196             const XalanDOMString&           xsldocURLString,
00197             StylesheetConstructionContext&  constructionContext) = 0;
00198   
00203     virtual void
00204     reset() = 0;
00205   
00212     virtual XalanNode*
00213     getSourceTreeFromInput(const XSLTInputSource&   inputSource) = 0;
00214 
00220     virtual const StylesheetRoot*
00221     getStylesheetRoot() const = 0;
00222 
00228     virtual void
00229     setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;
00230 
00237     virtual void
00238     setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;
00239 
00243     virtual void
00244     resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;
00245 
00251     virtual XMLParserLiaison&
00252     getXMLParserLiaison() const = 0;
00253 
00259     virtual const XalanDOMString
00260     getUniqueNamespaceValue() = 0;
00261 
00267     virtual void
00268     getUniqueNamespaceValue(XalanDOMString&     theValue) = 0;
00269 
00277    virtual void
00278    setStylesheetParam(
00279             const XalanDOMString&   key,
00280             XObjectPtr              value) = 0;
00281   
00289     virtual void
00290     setStylesheetParam(
00291             const XalanDOMString&   key,
00292             const XalanDOMString&   expression) = 0;
00293 
00307     virtual bool
00308     shouldStripSourceNode(
00309             StylesheetExecutionContext&     executionContext,
00310             const XalanNode&                node) const = 0;
00311 
00317     virtual FormatterListener*
00318     getFormatterListener() const = 0;
00319   
00325     virtual void
00326     setFormatterListener(FormatterListener*     flistener) = 0;  
00327 
00333     virtual size_type
00334     getTraceListeners() const = 0;
00335 
00341     virtual void
00342     addTraceListener(TraceListener*     tl) = 0;
00343 
00349     virtual void
00350     removeTraceListener(TraceListener*  tl) = 0;
00351 
00357     virtual void
00358     fireGenerateEvent(const GenerateEvent&  ge) = 0;
00359 
00365     virtual void
00366     fireTraceEvent(const TracerEvent&   te) = 0;
00367 
00373     virtual void
00374     fireSelectEvent(const SelectionEvent&   se) = 0;
00375 
00381     virtual bool
00382     getTraceSelects() const = 0;
00383 
00392     virtual void
00393     traceSelect(
00394             StylesheetExecutionContext&     executionContext,
00395             const ElemTemplateElement&      theStylesheetElement,
00396             const NodeRefListBase&          nl,
00397             const XPath*                    xpath) const = 0;
00398 
00407     virtual void
00408     setQuietConflictWarnings(bool b) = 0;
00409 
00418     virtual void
00419     setDiagnosticsOutput(PrintWriter* pw) = 0;
00420 
00428     virtual void
00429     message(
00430             const XalanDOMString&       msg,
00431             const XalanNode*            sourceNode = 0,
00432             const ElemTemplateElement*  styleNode = 0) const = 0;
00433 
00441     virtual void
00442     message(
00443             const XalanDOMString&   msg,
00444             const LocatorType&      locator,
00445             const XalanNode*        sourceNode = 0) const = 0;
00446 
00454     virtual void
00455     warn(
00456             const XalanDOMString&       msg,
00457             const XalanNode*            sourceNode = 0,
00458             const ElemTemplateElement*  styleNode = 0) const = 0;
00459 
00467     virtual void
00468     warn(
00469             const XalanDOMString&   msg,
00470             const LocatorType&      locator,
00471             const XalanNode*        sourceNode = 0) const = 0;
00472 
00473 
00481     virtual void
00482     error(
00483             const XalanDOMString&       msg,
00484             const XalanNode*            sourceNode = 0,
00485             const ElemTemplateElement*  styleNode = 0) const = 0;
00486 
00494     virtual void
00495     error(
00496             const XalanDOMString&   msg,
00497             const LocatorType&      locator,
00498             const XalanNode*        sourceNode = 0) const = 0;
00499 };
00500 
00501 
00502 
00503 XALAN_CPP_NAMESPACE_END
00504 
00505 
00506 
00507 #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.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.