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  

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