Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.3

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 <cstddef>
00072 
00073 
00074 
00075 #include <XalanDOM/XalanDOMString.hpp>
00076 
00077 
00078 
00079 class ElemTemplateElement;
00080 class FormatterListener;
00081 class GenerateEvent;
00082 class Locator;
00083 class NodeRefListBase;
00084 class PrefixResolver;
00085 class PrintWriter;
00086 class ResultTreeFragBase;
00087 class SelectionEvent;
00088 class StylesheetConstructionContext;
00089 class StylesheetExecutionContext;
00090 class StylesheetRoot;
00091 class TraceListener;
00092 class TracerEvent;
00093 class XalanDocument;
00094 class XalanElement;
00095 class XalanNode;
00096 class XMLParserLiaison;
00097 class XObject;
00098 class XObjectPtr;
00099 class XPathExecutionContext;
00100 class XSLTInputSource;
00101 class XSLTResultTarget;
00102 
00103 
00104 
00115 class XALAN_XSLT_EXPORT XSLTProcessor
00116 {
00117 public:
00118 
00119     typedef size_t  size_type;
00120 
00121     XSLTProcessor();
00122 
00123     virtual
00124     ~XSLTProcessor();
00125 
00138     virtual void
00139     process(
00140         const XSLTInputSource&          inputSource,
00141         const XSLTInputSource&          stylesheetSource,
00142         XSLTResultTarget&               outputTarget,
00143         StylesheetConstructionContext&  constructionContext,
00144         StylesheetExecutionContext&     executionContext) = 0;
00145 
00157     virtual void
00158     process(
00159             const XSLTInputSource&          inputSource,
00160             XSLTResultTarget&               outputTarget,
00161             StylesheetExecutionContext&     executionContext) = 0;
00162 
00172     virtual StylesheetRoot*
00173     processStylesheet(
00174             const XSLTInputSource&          stylesheetSource,
00175             StylesheetConstructionContext&  constructionContext) = 0;
00176   
00186     virtual StylesheetRoot*
00187     processStylesheet(
00188             const XalanDOMString&           xsldocURLString,
00189             StylesheetConstructionContext&  constructionContext) = 0;
00190   
00195     virtual void
00196     reset() = 0;
00197   
00203     virtual XalanDocument*
00204     getDOMFactory() const = 0;
00205 
00212     virtual XalanNode*
00213     getSourceTreeFromInput(const XSLTInputSource&   inputSource) = 0;
00214 
00220     virtual void
00221     outputToResultTree(const XObject&   xobj) = 0;
00222 
00228     virtual const StylesheetRoot*
00229     getStylesheetRoot() const = 0;
00230 
00236     virtual void
00237     setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;
00238 
00245     virtual void
00246     setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;
00247 
00251     virtual void
00252     resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;
00253 
00259     virtual XMLParserLiaison&
00260     getXMLParserLiaison() const = 0;
00261 
00267     virtual const XalanDOMString
00268     getUniqueNamespaceValue() = 0;
00269 
00275     virtual void
00276     getUniqueNamespaceValue(XalanDOMString&     theValue) = 0;
00277 
00285    virtual void
00286    setStylesheetParam(
00287             const XalanDOMString&   key,
00288             XObjectPtr              value) = 0;
00289   
00297     virtual void
00298     setStylesheetParam(
00299             const XalanDOMString&   key,
00300             const XalanDOMString&   expression) = 0;
00301 
00315     virtual bool
00316     shouldStripSourceNode(
00317             XPathExecutionContext&  executionContext,
00318             const XalanNode&        node) const = 0;
00319 
00325     virtual FormatterListener*
00326     getFormatterListener() const = 0;
00327   
00333     virtual void
00334     setFormatterListener(FormatterListener*     flistener) = 0;  
00335 
00341     virtual size_type
00342     getTraceListeners() const = 0;
00343 
00349     virtual void
00350     addTraceListener(TraceListener*     tl) = 0;
00351 
00357     virtual void
00358     removeTraceListener(TraceListener*  tl) = 0;
00359 
00365     virtual void
00366     fireGenerateEvent(const GenerateEvent&  ge) = 0;
00367 
00373     virtual void
00374     fireTraceEvent(const TracerEvent&   te) = 0;
00375 
00381     virtual void
00382     fireSelectEvent(const SelectionEvent&   se) = 0;
00383 
00389     virtual bool
00390     getTraceSelects() const = 0;
00391 
00398     virtual void
00399     traceSelect(
00400             const XalanElement&     theTemplate,
00401             const NodeRefListBase&  nl) const = 0;
00402 
00411     virtual void
00412     setQuietConflictWarnings(bool b) = 0;
00413 
00422     virtual void
00423     setDiagnosticsOutput(PrintWriter* pw) = 0;
00424 
00432     virtual void
00433     message(
00434             const XalanDOMString&   msg,
00435             const XalanNode*        sourceNode = 0,
00436             const XalanNode*        styleNode = 0) const = 0;
00437 
00445     virtual void
00446     message(
00447             const XalanDOMString&       msg,
00448             const XalanNode*            sourceNode,
00449             const ElemTemplateElement*  styleNode) const = 0;
00450 
00458     virtual void
00459     message(
00460             const XalanDOMString&   msg,
00461             const Locator&          locator,
00462             const XalanNode*        sourceNode = 0) const = 0;
00463 
00471     virtual void
00472     warn(
00473             const XalanDOMString&   msg,
00474             const XalanNode*        sourceNode = 0,
00475             const XalanNode*        styleNode = 0) const = 0;
00476 
00484     virtual void
00485     warn(
00486             const XalanDOMString&       msg,
00487             const XalanNode*            sourceNode,
00488             const ElemTemplateElement*  styleNode) const = 0;
00489 
00497     virtual void
00498     warn(
00499             const XalanDOMString&   msg,
00500             const Locator&          locator,
00501             const XalanNode*        sourceNode = 0) const = 0;
00502 
00510     virtual void
00511     error(
00512             const XalanDOMString&   msg,
00513             const XalanNode*        sourceNode = 0,
00514             const XalanNode*        styleNode = 0) const = 0;
00515 
00523     virtual void
00524     error(
00525             const XalanDOMString&       msg,
00526             const XalanNode*            sourceNode,
00527             const ElemTemplateElement*  styleNode) const = 0;
00528 
00536     virtual void
00537     error(
00538             const XalanDOMString&   msg,
00539             const Locator&          locator,
00540             const XalanNode*        sourceNode = 0) const = 0;
00541 };
00542 
00543 
00544 
00545 #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.3
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.