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  

XalanTransformer.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2000 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 #if !defined(XALAN_TRANSFORMER_HEADER_GUARD)
00058 #define XALAN_TRANSFORMER_HEADER_GUARD
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XalanTransformer/XalanTransformerDefinitions.hpp>
00064 
00065 
00066 
00067 #include <PlatformSupport/DOMStringHelper.hpp>
00068 
00069 
00070 
00071 #include <XPath/XObjectFactoryDefault.hpp>
00072 #include <XPath/XPathFactoryDefault.hpp>
00073 
00074 
00075 
00076 #include <XSLT/StylesheetConstructionContextDefault.hpp>
00077 #include <XSLT/StylesheetExecutionContextDefault.hpp>
00078 #include <XSLT/StylesheetRoot.hpp>
00079 #include <XSLT/XSLTEngineImpl.hpp>
00080 #include <XSLT/XSLTInit.hpp>
00081 #include <XSLT/XSLTInputSource.hpp>
00082 #include <XSLT/XSLTProcessorEnvSupportDefault.hpp>
00083 #include <XSLT/XSLTResultTarget.hpp>
00084 
00085 
00086 
00087 #include <XalanSourceTree/XalanSourceTreeDOMSupport.hpp>
00088 #include <XalanSourceTree/XalanSourceTreeParserLiaison.hpp>
00089 
00090 
00091 
00092 #include <XalanTransformer/XalanTransformerOutputStream.hpp>
00093 
00094 
00095 
00096 #if defined(XALAN_OLD_STREAM_HEADERS)
00097 #include <iostream.h>
00098 #else
00099 #include <iostream>
00100 #endif
00101 
00102 
00103 
00104 #if !defined(XALAN_NO_NAMESPACES)
00105     using std::ostream;
00106     using std::istream;
00107 #endif
00108 
00109 
00110 
00117 class XALAN_TRANSFORMER_EXPORT XalanTransformer
00118 {
00119 public:
00120     
00121     XalanTransformer();
00122 
00123     virtual ~XalanTransformer();
00124 
00130     static void
00131     initialize();
00132 
00138     static void
00139     terminate();
00140 
00147     const char*
00148     getLastError() const;
00149 
00161     int
00162     transform(
00163             const XSLTInputSource&      inputSource, 
00164             const XSLTInputSource&      stylesheetSource,
00165             XSLTResultTarget&           outputTarget);
00166 
00177     int
00178     transform(
00179             const char*                 theXMLFileName, 
00180             const char*                 theXSLFileName,
00181             const char*                 theOutFileName);
00182 
00193     int
00194     transform(
00195             const char*                 theXMLFileName, 
00196             const char*                 theOutFileName);
00197 
00208     int
00209     transform(
00210             const char*                 theXMLFileName, 
00211             const char*                 theXSLFileName,
00212             ostream&                    theOutStream);
00213 
00225     int
00226     transform(
00227             const char*                 theXMLFileName, 
00228             ostream&                    theOutStream);
00229 
00240     int
00241     transform(
00242             istream&                    theXMLInStream, 
00243             istream&                    theXSLInStream,
00244             ostream&                    theOutStream);
00245     
00256     int
00257     transform(
00258             istream&                    theXMLInStream, 
00259             ostream&                    theOutStream);
00260 
00279     int
00280     transform(
00281             const char*                 theXMLFileName, 
00282             const char*                 theXSLFileName,
00283             const void*                 theOutputHandle, 
00284             XalanOutputHandlerType      theOutputHandler,
00285             XalanFlushHandlerType       theFlushHandler = 0);
00286 
00287 protected:
00288 
00289 private:
00290 
00291     void 
00292     reset();
00293 
00294     XalanSourceTreeDOMSupport               m_domSupport;
00295 
00296     XalanSourceTreeParserLiaison            m_parserLiaison;
00297     
00298     XSLTProcessorEnvSupportDefault          m_xsltprocessorEnvSupport;
00299     
00300     XObjectFactoryDefault                   m_xobjectFactory;
00301     
00302     XPathFactoryDefault                     m_xpathFactory;
00303     
00304     XSLTEngineImpl                          m_processor;
00305     
00306     StylesheetConstructionContextDefault    m_stylesheetConstructionContext;
00307     
00308     StylesheetExecutionContextDefault       m_stylesheetExecutionContext;
00309 
00310     CharVectorType                          m_errorMessage;
00311 
00312     static XSLTInit*                        m_xsltInit;
00313 };
00314 
00315 
00316 
00317 #endif  // XALAN_TRANSFORMER_HEADER_GUARD
00318 
00319 
00320 

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.