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  

XercesBridgeNavigator.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(XERCESBRIDGENAVIGATOR_HEADER_GUARD_1357924680)
00058 #define XERCESBRIDGENAVIGATOR_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XercesParserLiaison/XercesParserLiaisonDefinitions.hpp>
00063 
00064 
00065 
00066 #include <cassert>
00067 
00068 
00069 
00070 class DOM_Attr;
00071 class DOM_Node;
00072 class XercesDocumentBridge;
00073 class XalanAttr;
00074 class XalanElement;
00075 class XalanNode;
00076 class XalanText;
00077 class DOM_Text;
00078 
00079 
00080 
00081 class XALAN_XERCESPARSERLIAISON_EXPORT XercesBridgeNavigator
00082 {
00083 public:
00084 
00085     explicit
00086     XercesBridgeNavigator(
00087             XercesDocumentBridge*   theOwnerDocument = 0,
00088             bool                    mappingMode = true);
00089 
00090     XercesBridgeNavigator(const XercesBridgeNavigator&  theSource);
00091 
00092     virtual
00093     ~XercesBridgeNavigator();
00094 
00095 
00096     XercesDocumentBridge*
00097     getOwnerDocument() const
00098     {
00099         return m_ownerDocument;
00100     }
00101 
00102     void
00103     setOwnerDocument(XercesDocumentBridge*  theDocument)
00104     {
00105         m_ownerDocument = theDocument;
00106     }
00107 
00108     XalanNode*
00109     mapNode(const DOM_Node&     theXercesNode) const;
00110 
00111     XalanAttr*
00112     mapNode(const DOM_Attr&     theXercesNode) const;
00113 
00114     DOM_Node
00115     mapNode(const XalanNode*    theXalanNode) const;
00116 
00117     DOM_Attr
00118     mapNode(const XalanAttr*    theXercesNode) const;
00119 
00120 public:
00121 
00122     unsigned long
00123     getIndex() const
00124     {
00125         return m_index;
00126     }
00127 
00128     void
00129     setIndex(unsigned long  theIndex)
00130     {
00131         m_index = theIndex;
00132     }
00133 
00134     XalanNode*
00135     getParentNode(const DOM_Node&   theXercesNode) const;
00136 
00137     XalanNode*
00138     getParentNode() const
00139     {
00140         return m_parentNode;
00141     }
00142 
00143     void
00144     setParentNode(XalanNode*    theParent)
00145     {
00146         m_parentNode = theParent;
00147     }
00148 
00149     XalanNode*
00150     getPreviousSibling(const DOM_Node&  theXercesNode) const;
00151 
00152     XalanNode*
00153     getPreviousSibling() const
00154     {
00155         return m_previousSibling;
00156     }
00157 
00158     void
00159     setPreviousSibling(XalanNode*   thePreviousSibling)
00160     {
00161         m_previousSibling = thePreviousSibling;
00162     }
00163 
00164     XalanNode*
00165     getNextSibling(const DOM_Node&  theXercesNode) const;
00166 
00167     XalanNode*
00168     getNextSibling() const
00169     {
00170         return m_nextSibling;
00171     }
00172 
00173     void
00174     setNextSibling(XalanNode*   theNextSibling)
00175     {
00176         m_nextSibling = theNextSibling;
00177     }
00178 
00179     XalanNode*
00180     getFirstChild(const DOM_Node&   theXercesNode) const;
00181 
00182     XalanNode*
00183     getFirstChild() const
00184     {
00185         return m_firstChild;
00186     }
00187 
00188     void
00189     setFirstChild(XalanNode*    theFirstChild)
00190     {
00191         m_firstChild = theFirstChild;
00192     }
00193 
00194     XalanNode*
00195     getLastChild(const DOM_Node&    theXercesNode) const;
00196 
00197     XalanNode*
00198     getLastChild() const
00199     {
00200         return m_lastChild;
00201     }
00202 
00203     void
00204     setLastChild(XalanNode* theLastChild)
00205     {
00206         m_lastChild = theLastChild;
00207     }
00208 
00209     XalanNode*
00210     insertBefore(
00211             DOM_Node&   theXercesParent,
00212             XalanNode*  newChild,
00213             XalanNode*  refChild) const;
00214 
00215     XalanNode*
00216     replaceChild(
00217             DOM_Node&   theXercesParent,
00218             XalanNode*  newChild,
00219             XalanNode*  oldChild) const;
00220 
00221     XalanNode*
00222     removeChild(
00223             DOM_Node&   theXercesParent,
00224             XalanNode*  oldChild) const;
00225 
00226     XalanNode*
00227     appendChild(
00228             DOM_Node&   theXercesParent,
00229             XalanNode*  newChild) const;
00230 
00231     XalanElement*
00232     getOwnerElement(const DOM_Attr&     theXercesAttr) const;
00233 
00234     XalanNode*
00235     cloneNode(
00236             const XalanNode*    theXalanNode,
00237             const DOM_Node&     theXercesNode,
00238             bool                deep) const;
00239 
00240     XalanText*
00241     splitText(
00242             DOM_Text&       theXercesText,
00243             unsigned int    offset) const;
00244 
00245 private:
00246 
00247     // Not implemented...
00248     bool
00249     operator==(const XercesBridgeNavigator& theRHS) const;
00250 
00251     // Data members...
00252     XercesDocumentBridge*   m_ownerDocument;
00253 
00254     mutable XalanNode*      m_parentNode;
00255 
00256     mutable XalanNode*      m_previousSibling;
00257 
00258     mutable XalanNode*      m_nextSibling;
00259 
00260     mutable XalanNode*      m_firstChild;
00261 
00262     mutable XalanNode*      m_lastChild;
00263 
00264     unsigned long           m_index;
00265 };
00266 
00267 
00268 
00269 #endif  // !defined(XERCESBRIDGENAVIGATOR_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.