Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XercesWrapperNavigator.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(XERCESWRAPPERNAVIGATOR_HEADER_GUARD_1357924680)
00058 #define XERCESWRAPPERNAVIGATOR_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XercesParserLiaison/XercesParserLiaisonDefinitions.hpp>
00063 
00064 
00065 
00066 #include <cassert>
00067 
00068 
00069 
00070 #include <xercesc/util/XercesDefs.hpp>
00071 
00072 
00073 
00074 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00075 #include <xalanc/XalanDOM/XalanNode.hpp>
00076 
00077 
00078 
00079 #include <xalanc/XercesParserLiaison/XercesWrapperTypes.hpp>
00080 
00081 
00082 
00083 XALAN_CPP_NAMESPACE_BEGIN
00084 
00085 
00086 
00087 class XercesDocumentWrapper;
00088 class XalanAttr;
00089 class XalanElement;
00090 class XalanText;
00091 
00092 
00093 
00094 class XALAN_XERCESPARSERLIAISON_EXPORT XercesWrapperNavigator
00095 {
00096 public:
00097 
00098     typedef XalanNode::IndexType    IndexType;
00099 
00100     explicit
00101     XercesWrapperNavigator(XercesDocumentWrapper*   theOwnerDocument = 0);
00102 
00103     XercesWrapperNavigator(const XercesWrapperNavigator&    theSource);
00104 
00105     virtual
00106     ~XercesWrapperNavigator();
00107 
00108 
00109     XercesDocumentWrapper*
00110     getOwnerDocument() const
00111     {
00112         return m_ownerDocument;
00113     }
00114 
00115     void
00116     setOwnerDocument(XercesDocumentWrapper*     theDocument)
00117     {
00118         m_ownerDocument = theDocument;
00119     }
00120 
00121     XalanNode*
00122     mapNode(const DOMNodeType*  theXercesNode) const;
00123 
00124     XalanAttr*
00125     mapNode(const DOMAttrType*  theXercesNode) const;
00126 
00127     const DOMNodeType*
00128     mapNode(XalanNode*  theXalanNode) const;
00129 
00130     IndexType
00131     getIndex() const
00132     {
00133         return m_index;
00134     }
00135 
00136     void
00137     setIndex(IndexType  theIndex)
00138     {
00139         m_index = theIndex;
00140     }
00141 
00142     XalanNode*
00143     getParentNode(const DOMNodeType*    theXercesNode) const;
00144 
00145     XalanNode*
00146     getParentNode() const
00147     {
00148         return m_parentNode;
00149     }
00150 
00151     void
00152     setParentNode(XalanNode*    theParent)
00153     {
00154         m_parentNode = theParent;
00155     }
00156 
00157     XalanNode*
00158     getPreviousSibling(const DOMNodeType*   theXercesNode) const;
00159 
00160     XalanNode*
00161     getPreviousSibling() const
00162     {
00163         return m_previousSibling;
00164     }
00165 
00166     void
00167     setPreviousSibling(XalanNode*   thePreviousSibling)
00168     {
00169         m_previousSibling = thePreviousSibling;
00170     }
00171 
00172     XalanNode*
00173     getNextSibling(const DOMNodeType*   theXercesNode) const;
00174 
00175     XalanNode*
00176     getNextSibling() const
00177     {
00178         return m_nextSibling;
00179     }
00180 
00181     void
00182     setNextSibling(XalanNode*   theNextSibling)
00183     {
00184         m_nextSibling = theNextSibling;
00185     }
00186 
00187     XalanNode*
00188     getFirstChild(const DOMNodeType*    theXercesNode) const;
00189 
00190     XalanNode*
00191     getFirstChild() const
00192     {
00193         return m_firstChild;
00194     }
00195 
00196     void
00197     setFirstChild(XalanNode*    theFirstChild)
00198     {
00199         m_firstChild = theFirstChild;
00200     }
00201 
00202     XalanNode*
00203     getLastChild(const DOMNodeType*     theXercesNode) const;
00204 
00205     XalanNode*
00206     getLastChild() const
00207     {
00208         return m_lastChild;
00209     }
00210 
00211     void
00212     setLastChild(XalanNode* theLastChild)
00213     {
00214         m_lastChild = theLastChild;
00215     }
00216 
00217     XalanElement*
00218     getOwnerElement(const DOMAttrType*  theXercesAttr) const;
00219 
00227     const XalanDOMString&
00228     getPooledString(const XMLCh*    theString) const;
00229 
00230 private:
00231 
00232     // Not implemented...
00233     bool
00234     operator==(const XercesWrapperNavigator&    theRHS) const;
00235 
00236     // Data members...
00237     XercesDocumentWrapper*  m_ownerDocument;
00238 
00239     XalanNode*              m_parentNode;
00240 
00241     XalanNode*              m_previousSibling;
00242 
00243     XalanNode*              m_nextSibling;
00244 
00245     XalanNode*              m_firstChild;
00246 
00247     XalanNode*              m_lastChild;
00248 
00249     IndexType               m_index;
00250 
00251     static const XalanDOMString     s_emptyString;
00252 };
00253 
00254 
00255 
00256 XALAN_CPP_NAMESPACE_END
00257 
00258 
00259 
00260 #endif  // !defined(XERCESWRAPPERNAVIGATOR_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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.