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  

FormatterToDOM.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(FORMATTERTODOM_HEADER_GUARD_1357924680)
00058 #define FORMATTERTODOM_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XMLSupport/XMLSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 // Base class header file.
00072 #include <XMLSupport/FormatterListener.hpp>
00073 
00074 
00075 
00076 #include <XalanDOM/XalanDOMString.hpp>
00077 
00078 
00079 
00080 class XalanDocument;
00081 class XalanDocumentFragment;
00082 class XalanElement;
00083 class XalanNode;
00084 
00085 
00086 
00091 class XALAN_XMLSUPPORT_EXPORT FormatterToDOM : public FormatterListener
00092 {
00093 public:
00094 
00098     static void
00099     initialize();
00100 
00104     static void
00105     terminate();
00106 
00107 
00116     FormatterToDOM(
00117             XalanDocument*          doc,
00118             XalanDocumentFragment*  docFrag,
00119             XalanElement*           currentElement);
00120 
00128     FormatterToDOM(
00129             XalanDocument*  doc,
00130             XalanElement*   elem);
00131 
00132     virtual
00133     ~FormatterToDOM();
00134 
00135 
00136     // These methods are inherited from DocumentHandler ...
00137 
00138     virtual void
00139     charactersRaw(
00140             const XMLCh* const  chars,
00141             const unsigned int  length);
00142 
00143     virtual void
00144     comment(const XMLCh* const  data);
00145 
00146     virtual void
00147     cdata(
00148             const XMLCh* const  ch,
00149             const unsigned int  length);
00150 
00151     virtual void
00152     entityReference(const XMLCh* const  name);
00153 
00154     virtual void
00155     setDocumentLocator(const Locator* const     locator);
00156 
00157     virtual void
00158     startDocument();
00159 
00160     virtual void
00161     endDocument();
00162 
00163     virtual void
00164     startElement(
00165                 const   XMLCh* const    name,
00166                 AttributeList&          attrs);
00167 
00168     virtual void
00169     endElement(const XMLCh* const   name);
00170 
00171     virtual void
00172     characters(
00173                 const XMLCh* const  chars,
00174                 const unsigned int  length);
00175 
00176     virtual void
00177     ignorableWhitespace(
00178                 const XMLCh* const  chars,
00179                 const unsigned int  length);
00180 
00181     virtual void
00182     processingInstruction(
00183             const XMLCh* const  target,
00184             const XMLCh* const  data);
00185 
00186     virtual void
00187     resetDocument();
00188 
00189     XalanDocument*
00190     getDocument() const
00191     {
00192         return m_doc;
00193     }
00194 
00195     XalanDocumentFragment*
00196     getDocumentFragment() const
00197     {
00198         return m_docFrag;
00199     }
00200 
00201     XalanElement*
00202     getCurrentElement() const
00203     {
00204         return m_currentElem;
00205     }
00206 
00207 private:
00208 
00212     void
00213     append(XalanNode*   newNode);
00214 
00215 
00216     // Data members...
00217     XalanDocument*                  m_doc;
00218 
00219     XalanDocumentFragment*          m_docFrag;
00220 
00221     XalanElement*                   m_currentElem;
00222 
00223 #if defined(XALAN_NO_NAMESPACES)
00224     typedef vector<XalanElement*>       ElementStackType;
00225 #else
00226     typedef std::vector<XalanElement*>  ElementStackType;
00227 #endif
00228 
00229     ElementStackType                m_elemStack;
00230 
00231     static const XalanDOMString&    s_xsltNextIsRawString;
00232 
00233     static const XalanDOMString&    s_formatterToDOMString;
00234 };
00235 
00236 
00237 
00238 #endif  // FORMATTERTODOM_HEADER_GUARD_1357924680

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.