Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

StylesheetRoot.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 #if !defined(XALAN_STYLESHEETROOT_HEADER_GUARD)
00058 #define XALAN_STYLESHEETROOT_HEADER_GUARD 
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include "XSLTDefinitions.hpp"
00064 
00065 
00066 
00067 #include "Stylesheet.hpp"
00068 
00069 
00070 
00071 #include <XalanDOM/XalanDOMString.hpp>
00072 
00073 
00074 
00075 #include <XMLSupport/FormatterListener.hpp>
00076 
00077 
00078 
00079 class StylesheetConstructionContext;
00080 class XMLURL;
00081 class XSLTResultTarget;
00082 
00083 
00084 
00090 class XALAN_XSLT_EXPORT StylesheetRoot : public Stylesheet
00091 {
00092 public:
00093 
00100     StylesheetRoot(
00101         const XalanDOMString&           baseIdentifier,
00102         StylesheetConstructionContext&  constructionContext);    
00103 
00104     virtual 
00105     ~StylesheetRoot();
00106 
00114     void
00115     process(
00116             XalanNode*                      sourceTree,
00117             XSLTResultTarget&               outputTarget,
00118             StylesheetExecutionContext&     executionContext) const;
00119 
00132     FormatterListener*
00133     setupFormatterListener(
00134             XSLTResultTarget&               outputTarget,
00135             StylesheetExecutionContext&     executionContext) const;
00136 
00143     FormatterListener::eFormat
00144     getOutputMethod() const
00145     {
00146         return m_outputMethod;
00147     }
00148 
00149     bool
00150     isOutputMethodSet() const
00151     {
00152         return getOutputMethod() == FormatterListener::OUTPUT_METHOD_NONE ? false : true;
00153     }
00154 
00161     XalanDOMString
00162     getOutputVersion() const
00163     { 
00164         return m_version;
00165     }
00166 
00173     bool 
00174     getOutputIndent() const
00175     {
00176         return m_indentResult;
00177     }
00178 
00185     XalanDOMString 
00186     getOutputEncoding() const
00187     {
00188         return m_encoding;
00189     }
00190 
00197     XalanDOMString 
00198     getJavaOutputEncoding() const;
00199 
00206     XalanDOMString 
00207     getOutputMediaType() const
00208     {
00209         return m_mediatype;
00210     }
00211 
00218     XalanDOMString 
00219     getOutputDoctypeSystem() const
00220     {
00221         return m_doctypeSystem;
00222     }
00223 
00230     XalanDOMString 
00231     getOutputDoctypePublic() const
00232     {
00233         return m_doctypePublic;
00234     }
00235 
00241     bool
00242     getOmitOutputXMLDecl() const
00243     {
00244         return m_omitxmlDecl;
00245     }
00246 
00253     XalanDOMString
00254     getOutputStandalone() const
00255     {
00256         return m_standalone;
00257     }
00258 
00264     ElemTemplate* 
00265     getDefaultTextRule() const
00266     {
00267         return m_defaultTextRule;
00268     }
00269 
00275     ElemTemplate* 
00276     getDefaultRule() const
00277     {
00278         return m_defaultRule;
00279     }
00280 
00286     ElemTemplate* 
00287     getDefaultRootRule() const
00288     {
00289         return m_defaultRootRule;
00290     }
00291 
00299     void 
00300     processOutputSpec(
00301             const XalanDOMChar*             name, 
00302             const AttributeList&            atts,
00303             StylesheetConstructionContext&  constructionContext);
00304 
00310     void 
00311     initDefaultRule(StylesheetConstructionContext&  constructionContext);
00312 
00317     XalanDOMString m_version;
00318 
00323     bool m_indentResult;
00324 
00329     XalanDOMString m_encoding;
00330 
00335     XalanDOMString m_mediatype;
00336 
00342     XalanDOMString m_doctypeSystem;
00343 
00352     XalanDOMString m_doctypePublic;
00353 
00357     bool m_omitxmlDecl;
00358 
00362     XalanDOMString m_standalone;
00363 
00369     URLStackType&
00370     getImportStack()
00371     {
00372         return m_importStack;
00373     }
00374 
00380     const URLStackType&
00381     getImportStack() const
00382     {
00383         return m_importStack;
00384     }
00385 
00391     void
00392     setIndentResult(bool bIndent)
00393     {
00394         m_indentResult = bIndent;
00395     }
00396 
00403     void
00404     setOutputMethod(FormatterListener::eFormat  meth)
00405     {
00406         m_outputMethod = meth;
00407     }
00408 
00414     const QNameVectorType&
00415     getCDATASectionElems() const
00416     {
00417         return m_cdataSectionElems;
00418     }
00419 
00432     void
00433     getNodeSetByKey(
00434             XalanNode*                      doc,
00435             const XalanDOMString&           name,
00436             const XalanDOMString&           ref,
00437             const PrefixResolver&           resolver,
00438             MutableNodeRefList&             nodelist,
00439             StylesheetExecutionContext&     executionContext,
00440             KeyTablesTableType&             theKeysTable) const;
00441 
00442 private:
00443 
00448     XalanDOMString  m_resultNameSpaceURL;
00449 
00453     FormatterListener::eFormat  m_outputMethod;
00454 
00459     QNameVectorType     m_cdataSectionElems;
00460 
00468     URLStackType m_importStack;
00469 
00470 
00476     ElemTemplate* m_defaultTextRule;
00477 
00483     ElemTemplate* m_defaultRule;
00484 
00495     ElemTemplate* m_defaultRootRule;
00496 
00497 };
00498 
00499 
00500 
00501 #endif  // XALAN_STYLESHEETROOT_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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.