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  

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 #include <XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 class DOM_Attr;
00075 class DOM_Node;
00076 class XercesDocumentBridge;
00077 class XalanAttr;
00078 class XalanElement;
00079 class XalanNode;
00080 class XalanText;
00081 class DOM_Text;
00082 
00083 
00084 
00085 class XALAN_XERCESPARSERLIAISON_EXPORT XercesBridgeNavigator
00086 {
00087 public:
00088 
00089     explicit
00090     XercesBridgeNavigator(
00091             XercesDocumentBridge*   theOwnerDocument = 0,
00092             bool                    mappingMode = true);
00093 
00094     XercesBridgeNavigator(const XercesBridgeNavigator&  theSource);
00095 
00096     virtual
00097     ~XercesBridgeNavigator();
00098 
00099 
00100     XercesDocumentBridge*
00101     getOwnerDocument() const
00102     {
00103         return m_ownerDocument;
00104     }
00105 
00106     void
00107     setOwnerDocument(XercesDocumentBridge*  theDocument)
00108     {
00109         m_ownerDocument = theDocument;
00110     }
00111 
00112     XalanNode*
00113     mapNode(const DOM_Node&     theXercesNode) const;
00114 
00115     XalanAttr*
00116     mapNode(const DOM_Attr&     theXercesNode) const;
00117 
00118     DOM_Node
00119     mapNode(const XalanNode*    theXalanNode) const;
00120 
00121     DOM_Attr
00122     mapNode(const XalanAttr*    theXercesNode) const;
00123 
00124     unsigned long
00125     getIndex() const
00126     {
00127         return m_index;
00128     }
00129 
00130     void
00131     setIndex(unsigned long  theIndex)
00132     {
00133         m_index = theIndex;
00134     }
00135 
00136     XalanNode*
00137     getParentNode(const DOM_Node&   theXercesNode) const;
00138 
00139     XalanNode*
00140     getParentNode() const
00141     {
00142         return m_parentNode;
00143     }
00144 
00145     void
00146     setParentNode(XalanNode*    theParent)
00147     {
00148         m_parentNode = theParent;
00149     }
00150 
00151     XalanNode*
00152     getPreviousSibling(const DOM_Node&  theXercesNode) const;
00153 
00154     XalanNode*
00155     getPreviousSibling() const
00156     {
00157         return m_previousSibling;
00158     }
00159 
00160     void
00161     setPreviousSibling(XalanNode*   thePreviousSibling)
00162     {
00163         m_previousSibling = thePreviousSibling;
00164     }
00165 
00166     XalanNode*
00167     getNextSibling(const DOM_Node&  theXercesNode) const;
00168 
00169     XalanNode*
00170     getNextSibling() const
00171     {
00172         return m_nextSibling;
00173     }
00174 
00175     void
00176     setNextSibling(XalanNode*   theNextSibling)
00177     {
00178         m_nextSibling = theNextSibling;
00179     }
00180 
00181     XalanNode*
00182     getFirstChild(const DOM_Node&   theXercesNode) const;
00183 
00184     XalanNode*
00185     getFirstChild() const
00186     {
00187         return m_firstChild;
00188     }
00189 
00190     void
00191     setFirstChild(XalanNode*    theFirstChild)
00192     {
00193         m_firstChild = theFirstChild;
00194     }
00195 
00196     XalanNode*
00197     getLastChild(const DOM_Node&    theXercesNode) const;
00198 
00199     XalanNode*
00200     getLastChild() const
00201     {
00202         return m_lastChild;
00203     }
00204 
00205     void
00206     setLastChild(XalanNode* theLastChild)
00207     {
00208         m_lastChild = theLastChild;
00209     }
00210 
00211     XalanNode*
00212     insertBefore(
00213             DOM_Node&   theXercesParent,
00214             XalanNode*  newChild,
00215             XalanNode*  refChild) const;
00216 
00217     XalanNode*
00218     replaceChild(
00219             DOM_Node&   theXercesParent,
00220             XalanNode*  newChild,
00221             XalanNode*  oldChild) const;
00222 
00223     XalanNode*
00224     removeChild(
00225             DOM_Node&   theXercesParent,
00226             XalanNode*  oldChild) const;
00227 
00228     XalanNode*
00229     appendChild(
00230             DOM_Node&   theXercesParent,
00231             XalanNode*  newChild) const;
00232 
00233     XalanElement*
00234     getOwnerElement(const DOM_Attr&     theXercesAttr) const;
00235 
00236     XalanNode*
00237     cloneNode(
00238             const XalanNode*    theXalanNode,
00239             const DOM_Node&     theXercesNode,
00240             bool                deep) const;
00241 
00242     XalanText*
00243     splitText(
00244             DOM_Text&       theXercesText,
00245             unsigned int    offset) const;
00246 
00254     const XalanDOMString&
00255     getPooledString(const XalanDOMString&   theString) const;
00256 
00264     const XalanDOMString&
00265     getPooledString(const XalanDOMChar*     theString) const;
00266 
00267 private:
00268 
00269     // Not implemented...
00270     bool
00271     operator==(const XercesBridgeNavigator& theRHS) const;
00272 
00273     // Data members...
00274     XercesDocumentBridge*   m_ownerDocument;
00275 
00276     mutable XalanNode*      m_parentNode;
00277 
00278     mutable XalanNode*      m_previousSibling;
00279 
00280     mutable XalanNode*      m_nextSibling;
00281 
00282     mutable XalanNode*      m_firstChild;
00283 
00284     mutable XalanNode*      m_lastChild;
00285 
00286     unsigned long           m_index;
00287 };
00288 
00289 
00290 
00291 #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.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.