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  

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 <PlatformSupport/FormatterListener.hpp>
00076 
00077 
00078 
00079 class StylesheetConstructionContext;
00080 class XSLTResultTarget;
00081 
00082 
00083 
00089 class XALAN_XSLT_EXPORT StylesheetRoot : public Stylesheet
00090 {
00091 public:
00092 
00099     StylesheetRoot(
00100         const XalanDOMString&           baseIdentifier,
00101         StylesheetConstructionContext&  constructionContext);    
00102 
00103     virtual 
00104     ~StylesheetRoot();
00105 
00109     virtual void
00110     postConstruction(StylesheetConstructionContext&     constructionContext);
00111 
00119     void
00120     process(
00121             XalanNode*                      sourceTree,
00122             XSLTResultTarget&               outputTarget,
00123             StylesheetExecutionContext&     executionContext) const;
00124 
00137     FormatterListener*
00138     setupFormatterListener(
00139             XSLTResultTarget&               outputTarget,
00140             StylesheetExecutionContext&     executionContext) const;
00141 
00148     FormatterListener::eFormat
00149     getOutputMethod() const
00150     {
00151         return m_outputMethod;
00152     }
00153 
00154     bool
00155     isOutputMethodSet() const
00156     {
00157         return getOutputMethod() == FormatterListener::OUTPUT_METHOD_NONE ? false : true;
00158     }
00159 
00166     XalanDOMString
00167     getOutputVersion() const
00168     { 
00169         return m_version;
00170     }
00171 
00178     bool 
00179     getOutputIndent() const
00180     {
00181         return m_indentResult;
00182     }
00183 
00190     XalanDOMString 
00191     getOutputEncoding() const
00192     {
00193         return m_encoding;
00194     }
00195 
00202     XalanDOMString 
00203     getOutputMediaType() const
00204     {
00205         return m_mediatype;
00206     }
00207 
00214     XalanDOMString 
00215     getOutputDoctypeSystem() const
00216     {
00217         return m_doctypeSystem;
00218     }
00219 
00226     XalanDOMString 
00227     getOutputDoctypePublic() const
00228     {
00229         return m_doctypePublic;
00230     }
00231 
00237     bool
00238     getOmitOutputXMLDecl() const
00239     {
00240         return m_omitxmlDecl;
00241     }
00242 
00249     XalanDOMString
00250     getOutputStandalone() const
00251     {
00252         return m_standalone;
00253     }
00254 
00260     ElemTemplate* 
00261     getDefaultTextRule() const
00262     {
00263         return m_defaultTextRule;
00264     }
00265 
00271     ElemTemplate* 
00272     getDefaultRule() const
00273     {
00274         return m_defaultRule;
00275     }
00276 
00282     ElemTemplate* 
00283     getDefaultRootRule() const
00284     {
00285         return m_defaultRootRule;
00286     }
00287 
00295     void 
00296     processOutputSpec(
00297             const XalanDOMChar*             name, 
00298             const AttributeList&            atts,
00299             StylesheetConstructionContext&  constructionContext);
00300 
00306     void 
00307     initDefaultRule(StylesheetConstructionContext&  constructionContext);
00308 
00313     XalanDOMString  m_version;
00314 
00319     bool            m_indentResult;
00320 
00325     XalanDOMString  m_encoding;
00326 
00331     XalanDOMString  m_mediatype;
00332 
00338     XalanDOMString  m_doctypeSystem;
00339 
00348     XalanDOMString  m_doctypePublic;
00349 
00353     bool            m_omitxmlDecl;
00354 
00358     XalanDOMString  m_standalone;
00359 
00365     URLStackType&
00366     getImportStack()
00367     {
00368         return m_importStack;
00369     }
00370 
00376     const URLStackType&
00377     getImportStack() const
00378     {
00379         return m_importStack;
00380     }
00381 
00387     void
00388     setIndentResult(bool bIndent)
00389     {
00390         m_indentResult = bIndent;
00391     }
00392 
00399     void
00400     setOutputMethod(FormatterListener::eFormat  meth)
00401     {
00402         m_outputMethod = meth;
00403     }
00404 
00405     bool
00406     hasCDATASectionElements() const
00407     {
00408         assert(m_hasCdataSectionElems == false && m_cdataSectionElems.size() == 0 ||
00409                m_hasCdataSectionElems == true && m_cdataSectionElems.size() != 0);
00410 
00411         return m_hasCdataSectionElems;
00412     }
00413 
00421     bool
00422     isCDATASectionElementName(const XalanQName&     theQName) const;
00423 
00436     void
00437     getNodeSetByKey(
00438             XalanNode*                      doc,
00439             const XalanDOMString&           name,
00440             const XalanDOMString&           ref,
00441             const PrefixResolver&           resolver,
00442             MutableNodeRefList&             nodelist,
00443             StylesheetExecutionContext&     executionContext,
00444             KeyTablesTableType&             theKeysTable) const;
00445 
00446 private:
00447 
00452     XalanDOMString              m_resultNameSpaceURL;
00453 
00457     FormatterListener::eFormat  m_outputMethod;
00458 
00463     QNameVectorType             m_cdataSectionElems;
00464 
00465     bool                        m_hasCdataSectionElems;
00466 
00471     URLStackType                m_importStack;
00472 
00473 
00478     ElemTemplate*               m_defaultTextRule;
00479 
00484     ElemTemplate*               m_defaultRule;
00485 
00490     ElemTemplate*               m_defaultRootRule;
00491 
00495     bool                        m_needToBuildKeysTable;
00496 };
00497 
00498 
00499 
00500 #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.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.