Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

Main Page   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-2004 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 <xalanc/XMLSupport/XMLSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 // Base class header file.
00072 #include <xalanc/PlatformSupport/FormatterListener.hpp>
00073 
00074 
00075 
00076 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00077 
00078 
00079 
00080 XALAN_CPP_NAMESPACE_BEGIN
00081 
00082 
00083 
00084 class XalanDocument;
00085 class XalanDocumentFragment;
00086 class XalanElement;
00087 class XalanNode;
00088 
00089 
00090 
00095 class XALAN_XMLSUPPORT_EXPORT FormatterToDOM : public FormatterListener
00096 {
00097 public:
00098 
00099 #if defined(XALAN_NO_STD_NAMESPACE)
00100     typedef vector<XalanElement*>       ElementStackType;
00101 #else
00102     typedef std::vector<XalanElement*>  ElementStackType;
00103 #endif
00104 
00113     FormatterToDOM(
00114             XalanDocument*          doc,
00115             XalanDocumentFragment*  docFrag,
00116             XalanElement*           currentElement);
00117 
00125     FormatterToDOM(
00126             XalanDocument*  doc,
00127             XalanElement*   elem);
00128 
00129     virtual
00130     ~FormatterToDOM();
00131 
00132 
00133     // These methods are inherited from DocumentHandler ...
00134 
00135     virtual void
00136     charactersRaw(
00137             const XMLCh* const  chars,
00138             const unsigned int  length);
00139 
00140     virtual void
00141     comment(const XMLCh* const  data);
00142 
00143     virtual void
00144     cdata(
00145             const XMLCh* const  ch,
00146             const unsigned int  length);
00147 
00148     virtual void
00149     entityReference(const XMLCh* const  name);
00150 
00151     virtual void
00152     setDocumentLocator(const LocatorType* const     locator);
00153 
00154     virtual void
00155     startDocument();
00156 
00157     virtual void
00158     endDocument();
00159 
00160     virtual void
00161     startElement(
00162                 const   XMLCh* const    name,
00163                 AttributeListType&      attrs);
00164 
00165     virtual void
00166     endElement(const XMLCh* const   name);
00167 
00168     virtual void
00169     characters(
00170                 const XMLCh* const  chars,
00171                 const unsigned int  length);
00172 
00173     virtual void
00174     ignorableWhitespace(
00175                 const XMLCh* const  chars,
00176                 const unsigned int  length);
00177 
00178     virtual void
00179     processingInstruction(
00180             const XMLCh* const  target,
00181             const XMLCh* const  data);
00182 
00183     virtual void
00184     resetDocument();
00185 
00186     XalanDocument*
00187     getDocument() const
00188     {
00189         return m_doc;
00190     }
00191 
00192     void
00193     setDocument(XalanDocument*  theDocument)
00194     {
00195         m_doc = theDocument;
00196     }
00197 
00198     XalanDocumentFragment*
00199     getDocumentFragment() const
00200     {
00201         return m_docFrag;
00202     }
00203 
00204     void
00205     setDocumentFragment(XalanDocumentFragment*  theDocumentFragment)
00206     {
00207         m_docFrag = theDocumentFragment;
00208     }
00209 
00210     XalanElement*
00211     getCurrentElement() const
00212     {
00213         return m_currentElem;
00214     }
00215 
00216     void
00217     setCurrentElement(XalanElement*     theElement)
00218     {
00219         m_currentElem = theElement;
00220     }
00221 
00222 private:
00223 
00227     void
00228     append(XalanNode*   newNode);
00229 
00237     XalanElement*
00238     createElement(
00239             const XalanDOMChar*     theElementName,
00240             AttributeListType&      attrs);
00241 
00242     void
00243     addAttributes(
00244             XalanElement*       theElement,
00245             AttributeListType&  attrs);
00246 
00247 
00248     // Data members...
00249     XalanDocument*                  m_doc;
00250 
00251     XalanDocumentFragment*          m_docFrag;
00252 
00253     XalanElement*                   m_currentElem;
00254 
00255     ElementStackType                m_elemStack;
00256 
00257     XalanDOMString                  m_buffer1;
00258 
00259     XalanDOMString                  m_buffer2;
00260 
00261     static const XalanDOMString     s_emptyString;
00262 };
00263 
00264 
00265 
00266 XALAN_CPP_NAMESPACE_END
00267 
00268 
00269 
00270 #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++ XSLT Processor Version 1.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.