## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.5

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